ListQuotaAlarms - 查询配额用量告警列表

查询配额用量告警列表。

接口说明

配额告警功能已升级,本 API 即将废弃,本 API 仅可查询旧版配额用量告警列表,若您想查询新版配额用量告警列表,请您使用云监控 API DescribeMetricRuleList 进行操作。使用 API 对新版配额告警进行操作的更多信息,请参见使用 API 管理新版配额告警

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quotas:ListQuotaAlarms

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

NextToken

string

用来标记开始读取数据的位置。

说明

不设置该参数,表示从头开始。

1

MaxResults

integer

本次读取的最大记录条数。

取值范围:1~200。默认值:30。

20

ProductCode

string

云产品的缩写名称。

说明

关于如何获取云产品的缩写名称,请参见 ListProductQuotas 中的ProductCode

ecs

AlarmName

string

配额用量告警名称。

q_hvnoqv alarm

QuotaActionCode

string

配额 ID。

说明
  • 关于如何获取云产品的配额 ID,请参见 ListProductQuotas 中的QuotaActionCode

  • 如果已设置本参数,则ProductCode必填。

q_hvnoqv

QuotaDimensions

array<object>

配额维度。

object

配额维度。

Key

string

配额维度的 Key。

说明
  • N 的取值范围取决于云产品支持的维度个数。

  • ProductCodeecsecs-specactiontrailess等时,配额维度的 Key 和 Value 必须同时设置。

regionId

Value

string

配额维度的 Key。

说明
  • N 的取值范围取决于云产品支持的维度个数。

  • ProductCodeecsecs-specactiontrailess等时,配额维度的 Key 和 Value 必须同时设置。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

无。

MaxResults

integer

本次请求返回的最大记录条数。

1

NextToken

string

用来标记当前调用返回读取到的位置。

说明

该参数返回为空,表示数据已读取完毕。

1

QuotaAlarms

array<object>

配额用量告警详情。

object

配额用量告警详情。

AlarmId

string

告警 ID。

a2efa7fc-832f-47bb-8054-39e28012****

AlarmName

string

告警名称。

q_hvnoqv alarm

CreateTime

string

创建配额用量告警的时间。

2020-11-27T07:23:34Z

ExceedThreshold

boolean

是否达到配额告警阈值。取值:

  • false

  • true

false

NotifyChannels

array

配额告警通知渠道。

string

告警通知渠道。取值:

  • sms:短消息。

  • email:电子邮件。

sms

NotifyTarget

string

告警通知对象。

说明

目前仅支持取值:accountContact。表示配置的账号联系人

accountContact

ProductCode

string

云服务名称缩写。

config

QuotaActionCode

string

配额 ID。

q_hvnoqv

QuotaDimensions

object

配额维度。

{"regionId":"cn-hangzhou"}

QuotaUsage

number

已使用配额。

73

QuotaValue

number

配额值。

200

Threshold

number

配额用量告警阈值的数值。

160

ThresholdPercent

number

配额用量告警阈值的百分比。

80

ThresholdType

string

配额告警类型。取值:

  • used:已使用量告警。

  • usable:剩余可用量告警。

used

WebHook

string

Webhook 地址。

https://www.aliyun.com/webhook

RequestId

string

请求 ID。

87F3B755-3BD2-4C76-B36A-93247002918C

TotalCount

integer

配额用量告警总数。

2

示例

正常返回示例

JSON格式

{
  "MaxResults": 1,
  "NextToken": "1",
  "QuotaAlarms": [
    {
      "AlarmId": "a2efa7fc-832f-47bb-8054-39e28012****",
      "AlarmName": "q_hvnoqv alarm",
      "CreateTime": "2020-11-27T07:23:34Z",
      "ExceedThreshold": false,
      "NotifyChannels": [
        "sms"
      ],
      "NotifyTarget": "accountContact",
      "ProductCode": "config",
      "QuotaActionCode": "q_hvnoqv",
      "QuotaDimensions": {
        "regionId": "cn-hangzhou"
      },
      "QuotaUsage": 73,
      "QuotaValue": 200,
      "Threshold": 160,
      "ThresholdPercent": 80,
      "ThresholdType": "used",
      "WebHook": "https://www.aliyun.com/webhook"
    }
  ],
  "RequestId": "87F3B755-3BD2-4C76-B36A-93247002918C",
  "TotalCount": 2
}

错误码

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

变更历史

更多信息,参考变更详情