文档首页/ 消息通知服务 SMN/ API参考/ API/ 主题操作/ 查询主题列表
更新时间：2024-09-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询主题列表

功能介绍

分页查询Topic列表，Topic列表按照Topic创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic，则返回空列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/notifications/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取项目ID请参考 获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

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字节。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

topic_count

Integer

返回的Topic个数。该参数不受offset和limit影响，即返回的是您账户下所有的Topic个数。

topics

Array of ListTopicsItem objects

Topic结构体数组。
表5 ListTopicsItem

参数

参数类型

描述

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

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码。

父主题： 主题操作