文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 监控与告警/ 查询当前用户自动告警配置 - ShowAutoCesAlarm
更新时间:2025-12-05 GMT+08:00
分享

查询当前用户自动告警配置 - ShowAutoCesAlarm

功能介绍

查询当前用户自动告警配置。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:listAll

read

-

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/auto-ces-alarm

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

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

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    表2 Query参数

    参数

    是否必选

    参数类型

    描述

    engine

    String

    参数解释

    数据库引擎。

    约束限制

    不涉及。

    取值范围

    • mysql
    • postgresql
    • sqlserver

    默认取值

    不涉及。

请求消息

无。

请求示例

查询当前用户自动告警列表。

GET https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/auto-ces-alram

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    entities

    Array of objects

    参数解释

    自动告警列表。详见表4

    count

    Integer

    参数解释

    总数量。

    取值范围

    不涉及。

    表4 entities元素结构说明

    名称

    参数类型

    说明

    id

    String

    参数解释

    告警记录唯一标识符。

    取值范围

    不涉及。

    domain_id

    String

    参数解释

    租户ID。

    取值范围

    不涉及。

    domain_name

    String

    参数解释

    租户名称。

    取值范围

    不涉及。

    user_id

    String

    参数解释

    用户ID。

    取值范围

    不涉及。

    user_name

    String

    参数解释

    用户名称。

    取值范围

    不涉及。

    project_id

    String

    参数解释

    项目ID。

    取值范围

    不涉及。

    project_name

    String

    参数解释

    项目名称。

    取值范围

    不涉及。

    engine_name

    String

    参数解释

    数据库引擎名称。

    取值范围

    不涉及。

    new_instance_default

    Boolean

    参数解释

    新实例是否默认开启自动告警。

    取值范围

    不涉及。

    switch_status

    String

    参数解释

    自动告警状态转换。

    取值范围

    不涉及。

    alarm_id

    String

    参数解释

    告警规则唯一标识符。

    取值范围

    不涉及。

    topic_urn

    String

    参数解释

    主题URN。

    取值范围

    不涉及。

    created_at

    String

    参数解释

    记录被创建的时间戳。

    取值范围

    不涉及。

    updated_at

    String

    参数解释

    记录最后一次被更新的时间戳。

    取值范围

    不涉及。

  • 正常响应样例
    {
      "entities": [
        {
          "id": "cd8fc267492d4efab6a62501d6acf5e1",
          "domain_id": "05491c53e680d4e80f60c007evd35fc0",
          "domain_name": "account_name",
          "project_id": "54623db08b174c858ba77002aa7923a3",
          "project_name": "project_name",
          "engine_name": "mysql",
          "new_instance_default": true,
          "switch_status": "closed",
          "alarm_id": "al16908078013717jEgojzo8",
          "topic_urn": "urn:smn:xxx:54623db08b174c858ba77002aa7923a3:AUTO_ALARM_NOTIFY_TOPIC_MYSQL_mysql_54623db08b174c858ba77002aa7923a3",
          "created_at": 1683339579161,
          "updated_at": 1760001523537
        }
      ],
      "count": 1
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档