文档首页/ 消息通知服务 SMN/ API参考/ API/ 主题操作/ 查询主题列表及主题关联资源信息 - ListTopicsWithAssociatedResources
更新时间:2025-12-16 GMT+08:00
分享

查询主题列表及主题关联资源信息 - ListTopicsWithAssociatedResources

功能介绍

查询Topic及Topic关联资源信息列表,关联资源信息随业务演进会持续扩展。Topic列表默认按照创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic,则返回空列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    smn:topic:listTopicsWithAssociatedResources

    List

    topic *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取项目ID请参考 获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量。

偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。

limit

Integer

查询的数量限制。

取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。

topic_id

String

检索的主题ID,完全匹配。

enterprise_project_id

String

企业项目id。

name

String

检索的主题名称,完全匹配。

fuzzy_name

String

检索的主题名称,模糊匹配。

fuzzy_display_name

String

检索的主题显示名。模糊匹配。参数字节长度不能大于192字节。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

topic_count

Integer

返回的Topic个数。该参数不受offset和limit影响,即返回的是您账户下所有的Topic个数。

topics

Array of ListTopicsWithAssociatedResourcesItem objects

Topic及关联资源信息结构体数组。

表5 ListTopicsWithAssociatedResourcesItem

参数

参数类型

描述

topic_urn

String

Topic的唯一的资源标识。

name

String

创建topic的名字。

display_name

String

Topic的显示名,推送邮件消息时,作为邮件发件人显示。

push_policy

Integer

消息推送的策略,该属性目前不支持修改,后续将支持修改。0表示发送失败,保留到失败队列,1表示直接丢弃发送失败的消息。

enterprise_project_id

String

企业项目ID。

topic_id

String

主题ID。

create_time

String

创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

tags

Array of ResourceTag objects

资源标签列表。

attributes

TopicAccessPolicyAttribute object

主题策略属性。

logtanks

Array of LogtankItem objects

云日志信息列表。

表6 ResourceTag

参数

参数类型

描述

key

String

键。

  • 最大长度127个unicode字符。

  • key不能为空。

value

String

值。

  • 每个值最大长度255个unicode字符。

表7 TopicAccessPolicyAttribute

参数

参数类型

描述

access_policy

String

topic的访问策略

create_time

String

topic的访问策略创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

topic的访问策略更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

表8 LogtankItem

参数

参数类型

描述

id

String

云日志信息唯一的资源标识。

log_group_id

String

云日志服务日志组ID。

log_stream_id

String

云日志服务日志流ID。

create_time

String

创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

状态码:400

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码:403

表10 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码:404

表11 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码:500

表12 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

查询主题列表及主题关联资源信息

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

响应示例

状态码: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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档