Updated on 2026-09-07 GMT+08:00

Querying SMN Topics

Function

This API is used to query SMN topics.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type

Enumerated values:

  • en-us

  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topics

Array of objects

Topic information.

For details, see SmnTopicInfo.

total_count

Integer

Total number of subjects

Table 4 SmnTopicInfo

Parameter

Type

Description

name

String

Topic name.

urn

String

Resource identifier of a topic, which is unique

description

String

Topic description.

push_policy

String

Message push policy. The value can be:

  • RETRY_ON_FAILURE: Failure messages will be saved in message queues.

  • DROP_ON_FAILURE: Failure messages will be discarded.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying all recorded information

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

Example Response

Status code: 200

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

Status code: 400

Bad Request

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

Status Code

Status Code

Description

200

OK

400

Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.