5.2 订阅操作
5.2.3 查询指定 Topic 的订阅者列表
"topic_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1", "protocol" : "email",
"subscription_urn" : "urn:smn:regionId:
762bdb3251034f268af0e395c53ea09b:test_topic_v1:a2d52a9f5c3b47f48c3fafb177a58796", "owner" : "762bdb3251034f268af0e395c53ea09b",
"endpoint" : "[email protected]", "remark" : "",
"status" : 0 } ]
}
状态码
状态码 描述
200 OK
400 Bad Request 403 Unauthorized 404 Not Found
500 Internal Server Error
错误码
请参见错误码。
5.2.3 查询指定 Topic 的订阅者列表
功能介绍
分页获取特定Topic的订阅列表，订阅列表按照订阅创建时间进行升序排列。分页查询 可以指定offset以及limit。如果指定Topic不存在订阅者，返回空列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions
表5-89 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
获取项目ID请参考获取项目ID。
参数 是否必选 参数类型 描述
topic_urn 是 String Topic的唯一的资源标识，可通 过查询主题列表获取该标识。
表5-90 Query 参数
参数 是否必选 参数类型 描述
offset 否 Integer 偏移量。
偏移量为一个大于0小于资源总 个数的整数，表示查询该偏移量 后面的所有的资源，默认值为 0。
缺省值：0
limit 否 Integer 查询的数量限制。
取值范围：1~100，取值一般为 10，20，50。功能说明：每页 返回的资源个数。默认值为 100。
缺省值：100
请求参数
表5-91 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
响应参数
状态码： 200
表5-92 响应 Body 参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
subscription_c
ount Integer 订阅者个数。
参数 参数类型 描述 subscriptions Array of
ListSubscripti onsItem objects
Subscription结构体。
表5-93 ListSubscriptionsItem
参数 参数类型 描述
topic_urn String Topic的唯一的资源标识。
protocol String 不同协议对应不同的endpoint（接受消息的接入 点）。目前支持的协议包括：
● “default”：默认协议。
● “email”：邮件传输协议，endpoint为邮箱 地址。
● “sms”：短信传输协议，endpoint为手机号 码。
● “functionstage”：FunctionGraph（函数）
传输协议，endpoint为一个函数。
● “http”、“https”：HTTP/HTTPS传输协 议，endpoint为URL。
subscription_u
rn String 订阅者的唯一资源标识。
owner String Topic创建者的项目ID。
endpoint String 接受消息的接入点。
remark String 备注。
status Integer 订阅者状态：0表示订阅还未确认，1表示已经确 认，3表示已经取消确认。
状态码： 400
表5-94 响应 Body 参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
code String 服务异常错误信息编码。
message String 服务异常错误信息描述。
状态码： 403
表5-95 响应 Body 参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
code String 服务异常错误信息编码。
message String 服务异常错误信息描述。
状态码： 404
表5-96 响应 Body 参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
code String 服务异常错误信息编码。
message String 服务异常错误信息描述。
状态码： 500
表5-97 响应 Body 参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
code String 服务异常错误信息编码。
message String 服务异常错误信息描述。
请求示例
查询指定Topic的订阅者列表
GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:
762bdb3251034f268af0e395c53ea09b:test_topic_v1/subscriptions?offset=0&limit=100 null
响应示例
状态码： 200 OK
{ "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"subscription_count" : 2, "subscriptions" : [ {
"topic_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1", "protocol" : "sms",
"subscription_urn" : "urn:smn:regionId:
762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837", "owner" : "762bdb3251034f268af0e395c53ea09b",
"endpoint" : "xxxxxxxxxxx", "remark" : "",
"status" : 0 }, {
"topic_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1", "protocol" : "email",
"subscription_urn" : "urn:smn:regionId:
762bdb3251034f268af0e395c53ea09b:test_topic_v1:a2d52a9f5c3b47f48c3fafb177a58796", "owner" : "762bdb3251034f268af0e395c53ea09b",
"endpoint" : "[email protected]", "remark" : "",
"status" : 0 } ]
}
状态码
状态码 描述
200 OK
400 Bad Request 403 Unauthorized 404 Not Found
500 Internal Server Error
错误码
请参见错误码。