文档

DescribeCloudGtmGlobalAlert - 获取全局告警配置

更新时间:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alidns:DescribeCloudGtmGlobalAlertWRITE
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AcceptLanguagestring

返回信息的语言类型:

  • zh-CN:中文

  • en-US:英文

en-US
ClientTokenstring

用户生成的请求 token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

1ae05db4-10e7-11ef-b126-00163e24**22

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

B57C121B-A45F-44D8-A9B2-13E5A5044195
AlertGrouparray

告警通知组列表。

string

告警通知组。

[\"云账号报警联系人\"]
AlertConfigarray<object>

报警配置列表。

object

报警规则配置信息。

NoticeTypestring

报警事件类型:

  • addr_alert:地址不可用

  • addr_resume:地址恢复可用

  • addr_pool_unavailable:地址池不可用

  • addr_pool_available:地址池恢复可用

addr_alert
SmsNoticeboolean

是否配置短信报警通知:

  • true:已配置,当报警事情发生时,会发送短信通知

  • false:未配置

仅中国站支持短信通知,国际站不支持短信通知。

true
EmailNoticeboolean

是否配置邮件报警通知:

  • true:已配置,当报警事情发生时,会发送邮件通知

  • false:未配置

true
DingtalkNoticeboolean

是否配置钉钉报警通知:

  • true:已配置,当报警事情发生时,会发送钉钉通知

  • false:未配置

false

示例

正常返回示例

JSON格式

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"云账号报警联系人\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "addr_alert",
        "SmsNotice": true,
        "EmailNotice": true,
        "DingtalkNotice": false
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。