文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例详情/ SMN主题查询 - ShowSmnTopicInfo
更新时间：2026-05-11 GMT+08:00
查看PDF
分享

SMN主题查询 - ShowSmnTopicInfo

功能介绍

SMN主题查询。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/smn/topic-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。 获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

枚举值：

  • en-us

  • zh-cn

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

topics

Array of objects

主题信息。

详情请参看SmnTopicInfo。

total_count

Integer

主题总数。
表4 SmnTopicInfo

参数

参数类型

描述

name

String

Topic的名字。

urn

String

Topic的唯一的资源标识。

description

String

Topic的描述信息。

push_policy

String

消息推送的策略，取值：

  • RETRY_ON_FAILURE：发送失败，保留到失败队列。

  • DROP_ON_FAILURE：直接丢弃发送失败的消息。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

已录入全部信息查询

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/smn/topic-info

响应示例

状态码：200

{
  "topics" : [ {
    "topic_urn" : "urn:smn:cn-southwest-184:5237e10fe9aa4ad5b16b6a5245248314:lihua",
    "topic_description" : "",
    "topic_name" : "lihua",
    "push_policy" : "RETRY_ON_FAILURE"
  } ],
  "total_count" : 1
}

状态码：400

Bad Request

{
  "error_code" : "DRS.M00261",
  "error_msg" : "Invalid project ID."
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。

父主题： 实例详情

相关文档