文档

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

更新时间:

查询配额用量告警列表。

调试

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

授权信息

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

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

请求参数

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

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

说明 不设置该参数,表示从头开始。
1
MaxResultsinteger

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

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

20
ProductCodestring

云产品的缩写名称。

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

配额用量告警名称。

规则创建数量告警
QuotaActionCodestring

配额 ID。

说明
  • 关于如何获取云产品的配额 ID,请参见 ListProductQuotas 中的QuotaActionCode
  • 如果已设置本参数,则ProductCode必填。
  • q_hvnoqv
    QuotaDimensionsobject []

    配额维度。

    Keystring

    配额维度的 Key。

    说明
  • N 的取值范围取决于云产品支持的维度个数。
  • ProductCodeecsecs-specactiontrailess等时,配额维度的 Key 和 Value 必须同时设置。
  • regionId
    Valuestring

    配额维度的 Key。

    说明
  • N 的取值范围取决于云产品支持的维度个数。
  • ProductCodeecsecs-specactiontrailess等时,配额维度的 Key 和 Value 必须同时设置。
  • cn-hangzhou

    返回参数

    名称类型描述示例值
    object

    无。

    TotalCountinteger

    配额用量告警总数。

    2
    QuotaAlarmsobject []

    配额用量告警详情。

    ThresholdPercentfloat

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

    80
    ThresholdTypestring

    配额告警类型。取值:

    • used:已使用量告警。
    • usable:剩余可用量告警。
    used
    QuotaDimensionsobject

    配额维度。

    {"regionId":"cn-hangzhou"}
    CreateTimestring

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

    2020-11-27T07:23:34Z
    QuotaActionCodestring

    配额 ID。

    q_hvnoqv
    AlarmNamestring

    告警名称。

    规则创建数量告警
    NotifyTargetstring

    告警通知对象。取值:accountContact。

    accountContact
    NotifyChannelsarray

    配额告警通知渠道。

    string

    告警通知渠道。取值:

    • sms:短消息。

    • email:电子邮件。

    sms
    QuotaUsagefloat

    已使用配额。

    73
    QuotaValuefloat

    配额值。

    200
    AlarmIdstring

    告警 ID。

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

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

    160
    ProductCodestring

    云服务名称缩写。

    config
    WebHookstring

    Webhook 地址。

    https://www.aliyun.com/webhook
    ExceedThresholdboolean

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

    • false

    • true

    false
    NextTokenstring

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

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

    请求 ID。

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

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

    1

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)