API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

API Request

URLs

GET zstack/v1/sns/application-platforms
GET zstack/v1/sns/application-platforms/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-platforms?q=state=Enabled

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-platforms/b9a635c9ff7c3544a232cad5b9a4aaf7

Queryable Fields

Run the CLI command line tool, enter QuerySNSApplicationPlatform and press Tab to view all queryable fields and the resource names that support cross-table queries.

API Response

Response Example

{
  "inventories": [
    {
      "uuid": "7ff3fb75fb844c7894a4a3b6d9fbce9a",
      "name": "email platform",
      "description": "example description",
      "state": "Enabled",
      "type": "Email",
      "createDate": "Mar 26, 2024 2:44:24 AM",
      "lastOpDate": "Mar 26, 2024 2:44:24 AM"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	5.0.0
error	ErrorCode	The error code. If not null, the operation failed. This field is null on success. See error	2.3
inventories	List	See inventories	2.3

#error

Name	Type	Description	Starting Version
code	String	The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001	0.6
description	String	A brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. Default is null	0.6
opaque	LinkedHashMap	Reserved field. Default is null	0.6
cause	ErrorCode	The root error that caused the current error. If there is no root error, this field is null	0.6

#inventories

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource, which uniquely identifies the resource	2.3
name	String	Resource name	2.3
description	String	Detailed description of the resource	2.3
type	String	Type	2.3
createDate	Timestamp	Creation time	2.3
lastOpDate	Timestamp	Last modification time	2.3

SDK Examples

Java SDK

QuerySNSApplicationPlatformAction action = new QuerySNSApplicationPlatformAction();
action.conditions = asList("state=Enabled");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSApplicationPlatformAction.Result res = action.call();

Python SDK

QuerySNSApplicationPlatformAction action = QuerySNSApplicationPlatformAction()
action.conditions = ["state=Enabled"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSApplicationPlatformAction.Result res = action.call()