Querying Topic Details

Description

• API name

  QueryTopicDetail

• Function

  Query the detailed information about a topic.

URI

• URI format

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

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID See Obtaining a Project ID.
  topic_urn	Yes	String	Unique resource ID of a topic. You can obtain it according to Querying Topics.

Request

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

Response

• Parameter description

  Parameter	Type	Description
  request_id	String	Request ID, which is unique
  name	String	Name of the topic
  topic_urn	String	Unique resource ID of a topic. You can obtain it according to Querying Topics.
  display_name	String	Topic display name, which is presented as the name of the email sender in email messages
  push_policy	int	Message pushing 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	Time when the topic was created The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
  update_time	String	Time when the topic was updated The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

• Response example

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

Returned Value

See section Returned Value.

Error Code

See section Error Code.