查询SMN主题
功能介绍
查询用户的SMN主题信息。通过该接口可查询用户的SMN主题配置信息，获取到主题名称、ID和数量等关键信息。能够快速获取用户的SMN主题信息，掌握消息推送的渠道和状态。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/lts/notifications/topics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
参数解释： 查询SMN主题信息列表的偏移量，初始值为0，后续从上一次的返回值中获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
limit |
是 |
Integer |
参数解释： 单次查询SMN主题信息列表时，允许返回的最大结果条数。 约束限制： 不涉及。 取值范围：
默认取值： 10 |
|
fuzzy_name |
否 |
String |
参数解释： 检索的主题名称，按照前缀匹配的模式进行模糊匹配。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 从IAM服务获取的用户Token，获取方式请参见：获取用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
Content-Type |
是 |
String |
参数解释： 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
参数解释： 本次请求的唯一标识。 取值范围： 不涉及。 |
|
topic_count |
Integer |
参数解释： SMN主题信息总数。 取值范围： 不涉及。 |
|
topics |
Array of Topics objects |
参数解释： SMN主题信息。 |
请求示例
查询SMN主题。
GET https://{endpoint}/v2/{project_id}/lts/notifications/topics
/v2/{project_id}/lts/notifications/topics?offset={offset}&limit={limit}
响应示例
状态码：200
请求响应成功。
{
"request_id" : "1",
"topic_count" : 100,
"topics" : [ {
"name" : "huawei",
"topic_urn" : "urn:smn:cn-north-7:{projectId}:fyy",
"display_name" : "",
"push_policy" : 0
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求响应成功。 |
错误码
请参见错误码。
