Updated on 2026-08-25 GMT+08:00

Obtaining the SMN Topic List

Function

This API is used to obtain the SMN topic list.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    das::showCloudDBAInfo

    Read

    -

    -

    -

    -

URI

GET /v3/{project_id}/health-report/get-smn-topic-list

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset value

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Number of records on each page

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Definition

Whether the request is successful

Range

N/A

request_id

String

Definition

Unique ID of a request

Range

N/A

topic_count

Integer

Definition

Number of returned topics. No matter what you have set for offset and limit in the request, this API always returns the total number of topics in your account.

Range

N/A

topics

Array of Table 4 objects

Definition

Topic structure array

Range

N/A

Table 4 ListTopicsItem

Parameter

Type

Description

topic_urn

String

Definition

Unique resource identifier of a topic

Range

N/A

name

String

Definition

Topic name

Range

N/A

display_name

String

Definition

Topic display name as the name of an email sender

Range

N/A

push_policy

Integer

Definition

Message push policy. This attribute cannot be modified currently and will be modified in the future. 0 indicates that the message sending fails and the message is cached in the queue. 1 indicates that the failed message is discarded.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID

Range

N/A

topic_id

String

Definition

Topic ID

Range

N/A

Example Requests

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/health-report/get-smn-topic-list?offset=0&limit=100 
 

Example Responses

Status code: 200

Success.

{
    "success": true,
    "request_id": "2f2ff5bb938943c78721c8014246dfde",
    "topic_count": 1,
    "topics": [
        {
            "topic_urn": "urn:smn:cn-north-7:052041494800d57c2f02c00275b4c247:DB_OM_Team",
            "name": "DB_OM_Team",
            "display_name": "DB_OM_Team",
            "push_policy": "0",
            "enterprise_project_id": "0",
            "topic_id": "20794f763835433faf2efe4fe730b1a9"
        }
    ]
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.