Help Center/ Simple Message Notification/ API Reference/ APIs/ Topics/ Querying the Topic List Along with Their Associated Resources
Updated on 2025-12-16 GMT+08:00

Querying the Topic List Along with Their Associated Resources

Function

This API is used to query the topic list along with their associated resources. The associated resources will grow as the service expands. By default, topics are sorted by creation time in descending order. You can specify offset and limit for pagination query. If no topic is found, an empty list is returned.

Calling Method

For details, see Calling APIs.

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 Policies and Supported Actions for details on the required permissions.
  • 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

    smn:topic:listTopicsWithAssociatedResources

    List

    topic *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

GET /v2/{project_id}/notifications/topics-with-associated-resources

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.For details about how to obtain the project ID, see Obtaining the Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

The query offset.

If the offset is an integer greater than 0 but less than the total number of resources, all resources in excess of this offset will be queried. The default offset is 0.

limit

No

Integer

The maximum number of records in each query.

Value range: 1 to 100. Generally, the value is 10, 20, or 50. Function description: The number of resources returned on each page. Default value: 100.

topic_id

No

String

The topic ID to retrieve. Exact matching is applied.

enterprise_project_id

No

String

The enterprise project ID.

name

No

String

The topic name to retrieve. Exact matching is applied.

fuzzy_name

No

String

The topic name to retrieve. Fuzzy matching is applied.

fuzzy_display_name

No

String

The topic display name to retrieve. Fuzzy matching is applied. The display name cannot exceed 192 bytes.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

request_id

String

The unique request ID.

topic_count

Integer

The 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.

topics

Array of ListTopicsWithAssociatedResourcesItem objects

The structured array of a topic and its associated resource information.

Table 5 ListTopicsWithAssociatedResourcesItem

Parameter

Type

Description

topic_urn

String

The unique resource identifier of a topic.

name

String

The topic name.

display_name

String

The topic display name, which will be the name of an email sender.

push_policy

Integer

The message push policy. This attribute is not modifiable. 0 indicates that the message fails to be sent and is retained in the failure queue. 1 indicates that the message that fails to be sent is discarded.

enterprise_project_id

String

The enterprise project ID.

topic_id

String

The topic ID.

create_time

String

The creation time. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

The update time. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

tags

Array of ResourceTag objects

The list of resource tags.

attributes

TopicAccessPolicyAttribute object

Topic policy attributes.

logtanks

Array of LogtankItem objects

The list of LTS logs.

Table 6 ResourceTag

Parameter

Type

Description

key

String

The tag key.

  • A key can contain a maximum of 127 Unicode characters.

  • The tag key cannot be left blank.

value

String

The tag value.

  • Each tag value can contain a maximum of 255 Unicode characters.

Table 7 TopicAccessPolicyAttribute

Parameter

Type

Description

access_policy

String

The access policy of a topic.

create_time

String

The time when the topic access policy was created. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

The time when the topic access policy was updated. It is a UTC time in YYYY-MM-DDTHH:MM:SSZ format.

Table 8 LogtankItem

Parameter

Type

Description

id

String

Specifies the resource identifier of the cloud log, which is unique.

log_group_id

String

Specifies the LTS log group ID.

log_stream_id

String

Specifies the LTS log stream ID.

create_time

String

Specifies the creation time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

Specifies the update time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

Status code: 400

Table 9 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 10 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 11 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 12 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 the topic list along with their associated resources

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics-with-associated-resources?offset=0&limit=100

Example Responses

Status code: 200

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "topic_count" : 1,
  "topics" : [ {
    "topic_urn" : "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic_v2",
    "display_name" : "testtest",
    "name" : "test_topic_v1",
    "push_policy" : 0,
    "enterprise_project_id" : "0",
    "topic_id" : "84698185946d44d08431aa441d8e2cf2",
    "create_time" : "2016-08-02T08:22:18Z",
    "update_time" : "2016-08-02T08:22:18Z",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value3"
    } ],
    "attributes" : {
      "access_policy" : "{\"Version\":\"2016-09-07\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__user_pub_0\",\"Effect\":\"Allow\",\"Principal\":[{\"CSP\":[\"urn:csp:iam::93dc1b4697ac493d9b7d089569f86b32:root\"]}],\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"},{\"Sid\":\"__org_path_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"OrgPath\":[\"o-bf966fe82ebb4d35d68b791729228788/r-001ebf32880a13eabfc8e1c37eee3ae9/ou-0dbfffe92fd92ddb35feff9b4079459c\"]},\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"},{\"Sid\":\"__service_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"obs\"]},\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa\"}]}",
      "create_time" : "2016-08-01T02:16:38",
      "update_time" : "2016-08-01T02:16:38"
    },
    "logtanks" : [ {
      "id" : "4ea80c8a68b840e19b4efd3a8f0d62ed",
      "log_group_id" : "d1b6c352-ee45-4196-9230-c74b7894e356",
      "log_stream_id" : "114960b4-1c26-48dd-93c2-4caae24aec49",
      "create_time" : "2022-10-10T09:00:00Z",
      "update_time" : "2022-10-10T09:00:00Z"
    } ]
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;


public class ListTopicsWithAssociatedResourcesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SmnClient client = SmnClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTopicsWithAssociatedResourcesRequest request = new ListTopicsWithAssociatedResourcesRequest();
        try {
            ListTopicsWithAssociatedResourcesResponse response = client.listTopicsWithAssociatedResources(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SmnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTopicsWithAssociatedResourcesRequest()
        response = client.list_topics_with_associated_resources(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTopicsWithAssociatedResourcesRequest{}
	response, err := client.ListTopicsWithAssociatedResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.