Help Center/ Simple Message Notification/ API Reference/ APIs/ Topics/ Querying Details About a Topic

Updated on 2024-04-19 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Details About a Topic

Function

This API is used to query details about a topic.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.
topic_urn	Yes	String	Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
update_time	String	Specifies when the topic was updated. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
push_policy	Integer	Specifies the message push policy. 0 indicates that the message sending fails and the message is cached in the queue. 1 indicates that the failed message is discarded.
create_time	String	Specifies when the topic is created. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
name	String	Specifies the topic name.
topic_urn	String	It is the unique identifier of a topic. To obtain the resource identifier, see Querying Topics.
display_name	String	Specifies the topic display name, which is presented as the name of the email sender in email messages.
request_id	String	Specifies the request ID, which is unique.
enterprise_project_id	String	Specifies the enterprise project ID.
topic_id	String	Specifies the topic ID.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Example Requests

Querying details about a topic

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

null

Example Responses

Status code: 200

{
  "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"
}