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

查询主题详情

功能介绍

查询Topic的详细信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/notifications/topics/{topic_urn}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取项目ID请参考 获取项目ID。

topic_urn

是

String

Topic的唯一的资源标识，可通过查询主题列表获取该标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

update_time

String

更新时间。时间格式为UTC时间，YYYY-MM-DDTHH:MM:SSZ。

push_policy

Integer

消息推送的策略。0表示发送失败，保留到失败队列，1表示直接丢弃发送失败的消息。

create_time

String

创建时间。时间格式为UTC时间，YYYY-MM-DDTHH:MM:SSZ。

name

String

创建Topic的名字。

topic_urn

String

Topic的唯一的资源标识。可以通过查看主题列表获取该标识。

display_name

String

Topic的显示名，推送邮件消息时，作为邮件发件人显示。

request_id

String

请求的唯一标识ID。

enterprise_project_id

String

企业项目ID。

topic_id

String

主题ID。

状态码：400

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：403

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：404

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：500

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

查询主题详情

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2

null

响应示例

状态码：200

OK

{
  "update_time" : "2016-08-01T02:16:38Z",
  "push_policy" : 0,
  "create_time" : "2016-08-01T02:16:38Z",
  "name" : "test_create_topic_v2",
  "topic_urn" : "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2",
  "display_name" : "test create topic v2",
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "enterprise_project_id" : "0",
  "topic_id" : "84698185946d44d08431aa441d8e2cf2"
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 主题操作

相关文档