- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- API参考
- SDK参考
- 场景代码示例
-
常见问题
- 消息通知服务有哪些优势?
- 消息通知服务支持的传输协议有哪些?
- 消息通知服务的使用如何收费和计费?
- 消息通知服务的主题名称有何格式要求?
- 每个用户可以创建多少个主题?
- 每个主题最多支持多少个订阅者?
- 可以向主题发布多少条消息?
- 每个用户可以创建多少个消息模板?
- 以短信方式接收消息的限制是什么?
- 单个主题是否支持通过多种传输协议进行订阅?
- 主题创建者是否可以控制所创建的主题中允许的传输协议?
- 订阅终端地址可以修改吗?
- 是否可删除已发布的消息?
- 是否会保证将消息传送到订阅的终端节点?
- 每条消息会让订阅者收到多少次?
- 向主题推送消息后,订阅者为什么没有收到消息?
- 为什么用户接收到的邮件中图片无法显示?
- 使用消息通知服务发送短信的号码或显示名可以保持一致吗?
- 如何获取用户的账号ID?
- 钉钉机器人、钉钉企业内部机器人、飞书机器人、企业微信机器人如何获取订阅终端?
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询主题列表
功能介绍
分页查询Topic列表,Topic列表按照Topic创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic,则返回空列表。
调用方法
请参见如何调用API。
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 |
错误码
请参见错误码。