开发手册 | 5.4.12 | ZStack Cloud · ZCF

API请求

URLs

GET zstack/v1/sns/topics/subscribers
GET zstack/v1/sns/topics/subscribers/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/topics/subscribers?q=topicUuid=3677dc0f00964b80886f3b2bbf9338cd

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

可查询字段

运行CLI命令行工具，输入QuerySNSTopicSubscriber并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "topicUuid": "3677dc0f00964b80886f3b2bbf9338cd",
      "endpointUuid": "f8c5c56233844126ad5f5a0174da3098"
    }
  ]
}

名字	类型	描述	起始版本
success	boolean		5.0.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.3.1
inventories	List	详情参考inventories	2.3.1

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	2.3.1
description	String	错误的概要描述	2.3.1
details	String	错误的详细信息	2.3.1
elaboration	String	保留字段，默认为null	2.3.1
opaque	LinkedHashMap	保留字段，默认为null	2.3.1
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	2.3.1

#inventories

名字	类型	描述	起始版本
topicUuid	String	主题UUID	2.3.1
endpointUuid	String	终端UUID	2.3.1
createDate	Timestamp	创建时间	2.3.1
lastOpDate	Timestamp	最后一次修改时间	2.3.1

SDK示例

Java SDK

QuerySNSTopicSubscriberAction action = new QuerySNSTopicSubscriberAction();
action.conditions = asList("topicUuid=3677dc0f00964b80886f3b2bbf9338cd");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSTopicSubscriberAction.Result res = action.call();

Python SDK

QuerySNSTopicSubscriberAction action = QuerySNSTopicSubscriberAction()
action.conditions = ["topicUuid=3677dc0f00964b80886f3b2bbf9338cd"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSTopicSubscriberAction.Result res = action.call()

查询订阅主题的终端（QuerySNSTopicSubscriber）

API请求

API返回

SDK示例