调用ListQuotaAlarms接口查询配额用量告警列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListQuotaAlarms

要执行的操作,取值:ListQuotaAlarms

NextToken String 1

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

说明 不设置该参数,表示从头开始。
MaxResults Integer 20

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

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

ProductCode String ecs

云服务名称缩写。

说明 详情请参见支持配额中心的云服务
AlarmName String 规则创建数量告警

配额用量告警名称。

QuotaActionCode String q_hvnoqv

配额ID。

QuotaDimensions.N.Key String regionId

配额维度的Key。

说明 N的取值范围取决于对应云服务支持的维度个数。
QuotaDimensions.N.Value String cn-hangzhou

配额维度的Value。

说明 N的取值范围取决于对应云服务支持的维度个数。

返回数据

名称 类型 示例值 描述
TotalCount Integer 2

配额用量告警总数。

QuotaAlarms Array of QuotaAlarm

配额用量告警详情。

ThresholdPercent Float 80

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

ThresholdType String used

配额告警类型。取值:

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

配额维度。

CreateTime String 2020-11-27T07:23:34Z

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

QuotaActionCode String q_hvnoqv

配额ID。

AlarmName String 规则创建数量告警

告警名称。

NotifyTarget String accountContact

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

NotifyChannels Array of String sms

告警通知渠道。取值:

  • sms:短消息。
  • email:电子邮件。
QuotaUsage Float 73

已使用配额。

QuotaValue Float 200

配额值。

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

告警ID。

Threshold Float 160

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

ProductCode String config

云服务名称缩写。

WebHook String https://www.aliyun.com/webhook

Webhook地址。

ExceedThreshold Boolean false

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

  • false
  • true
NextToken String 1

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

说明 该参数返回为空,表示数据已读取完毕。
RequestId String 87F3B755-3BD2-4C76-B36A-93247002918C

请求ID。

MaxResults Integer 1

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListQuotaAlarms
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListQuotaAlarmsResponse>
	<TotalCount>2</TotalCount>
	<QuotaAlarms>
		<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>
		<QuotaActionCode>q_hvnoqv</QuotaActionCode>
		<NotifyChannels>sms</NotifyChannels>
		<QuotaValue>200</QuotaValue>
		<QuotaDimensions/>
		<AlarmName>规则创建数量告警</AlarmName>
		<ProductCode>config</ProductCode>
		<NotifyTarget>accountContact</NotifyTarget>
		<CreateTime>2020-11-27T07:23:34Z</CreateTime>
		<QuotaUsage>73</QuotaUsage>
		<ExceedThreshold>false</ExceedThreshold>
		<Threshold>160</Threshold>
	</QuotaAlarms>
	<QuotaAlarms>
		<AlarmId>3f42ae59-edd0-44ad-aed1-b7aa36ff****</AlarmId>
		<QuotaActionCode>q_elastic-network-interfaces</QuotaActionCode>
		<NotifyChannels>sms</NotifyChannels>
		<NotifyChannels>email</NotifyChannels>
		<QuotaValue>50000</QuotaValue>
		<QuotaDimensions>
			<regionId>cn-hangzhou</regionId>
		</QuotaDimensions>
		<AlarmName>test123</AlarmName>
		<ProductCode>ecs</ProductCode>
		<NotifyTarget>accountContact</NotifyTarget>
		<CreateTime>2020-11-27T06:51:35Z</CreateTime>
		<QuotaUsage>1</QuotaUsage>
		<ExceedThreshold>false</ExceedThreshold>
		<Threshold>5</Threshold>
	</QuotaAlarms>
	<RequestId>87F3B755-3BD2-4C76-B36A-93247002918C</RequestId>
	<MaxResults>2</MaxResults>
</ListQuotaAlarmsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "QuotaAlarms" : [ {
    "AlarmId" : "a2efa7fc-832f-47bb-8054-39e28012****",
    "QuotaActionCode" : "q_hvnoqv",
    "NotifyChannels" : [ "sms" ],
    "QuotaValue" : 200,
    "QuotaDimensions" : { },
    "AlarmName" : "规则创建数量告警",
    "ProductCode" : "config",
    "NotifyTarget" : "accountContact",
    "CreateTime" : "2020-11-27T07:23:34Z",
    "QuotaUsage" : 73,
    "ExceedThreshold" : false,
    "Threshold" : 160
  }, {
    "AlarmId" : "3f42ae59-edd0-44ad-aed1-b7aa36ff****",
    "QuotaActionCode" : "q_elastic-network-interfaces",
    "NotifyChannels" : [ "sms", "email" ],
    "QuotaValue" : 50000,
    "QuotaDimensions" : {
      "regionId" : "cn-hangzhou"
    },
    "AlarmName" : "test123",
    "ProductCode" : "ecs",
    "NotifyTarget" : "accountContact",
    "CreateTime" : "2020-11-27T06:51:35Z",
    "QuotaUsage" : 1,
    "ExceedThreshold" : false,
    "Threshold" : 5
  } ],
  "RequestId" : "87F3B755-3BD2-4C76-B36A-93247002918C",
  "MaxResults" : 2
}

错误码

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