查询主题列表 - ListTopics
功能介绍
分页查询Topic列表，Topic列表按照Topic创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic，则返回空列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
smn:topic:listTopic
List
topic *
-
- smn:topic:list
-
-
g:EnterpriseProjectId
URI
GET /v2/{project_id}/notifications/topics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取项目ID请参考 获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量。 偏移量为一个大于0小于资源总个数的整数，表示查询该偏移量后面的所有的资源，默认值为0。 |
|
limit |
否 |
Integer |
查询的数量限制。 取值范围：1~100，取值一般为10，20，50。功能说明：每页返回的资源个数。默认值为100。 |
|
enterprise_project_id |
否 |
String |
企业项目id。 |
|
name |
否 |
String |
检索的主题名称，完全匹配。 |
|
fuzzy_name |
否 |
String |
检索的主题名称，模糊匹配。 |
|
topic_id |
否 |
String |
检索的主题ID，完全匹配。 |
|
fuzzy_display_name |
否 |
String |
检索的主题显示名。模糊匹配。参数字节长度不能大于192字节。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
topic_count |
Integer |
返回的Topic个数。该参数不受offset和limit影响，即返回的是您账户下所有的Topic个数。 |
|
topics |
Array of ListTopicsItem objects |
Topic结构体数组。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
topic_urn |
String |
Topic的唯一的资源标识。 |
|
name |
String |
创建topic的名字。 |
|
display_name |
String |
Topic的显示名，推送邮件消息时，作为邮件发件人显示。 |
|
push_policy |
Integer |
消息推送的策略，该属性目前不支持修改，后续将支持修改。0表示发送失败，保留到失败队列，1表示直接丢弃发送失败的消息。 |
|
enterprise_project_id |
String |
企业项目ID。 |
|
topic_id |
String |
主题ID。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
请求示例
查询主题列表
GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics?offset=0&limit=100
null
响应示例
状态码：200
OK
{
"request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"topic_count" : 1,
"topics" : [ {
"topic_urn" : "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic_v2",
"display_name" : "testtest",
"name" : "test_topic_v1",
"push_policy" : 0,
"enterprise_project_id" : "0",
"topic_id" : "84698185946d44d08431aa441d8e2cf2"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
403 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
