文档首页/ 数据管理服务 DAS/ API参考/ API(公测中)/ 云DBA/ 获取smn主题列表 - GetSmnTopicList
更新时间:2025-12-02 GMT+08:00
分享

获取smn主题列表 - GetSmnTopicList

功能介绍

获取smn主题列表。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

请求参数

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移数值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

limit

Integer

参数解释:

每页的数据量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

success

Boolean

参数解释:

是否成功。

取值范围:

不涉及。

request_id

String

参数解释:

请求的唯一标识ID。

取值范围:

不涉及。

topic_count

Integer

参数解释:

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

取值范围:

不涉及。

topics

Array of 表4 objects

参数解释:

Topic结构体数组。

取值范围:

不涉及。

表4 ListTopicsItem

参数

参数类型

描述

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。

取值范围:

不涉及。

请求示例

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

响应示例

状态码: 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"
        }
    ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档