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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	用来标记开始读取数据的位置。说明不设置该参数，表示从头开始。	1
MaxResults	integer	否	本次读取的最大记录条数。取值范围：1~200。默认值：30。	20
ProductCode	string	否	云服务名称缩写。说明详情请参见支持配额中心的云服务。	ecs
AlarmName	string	否	配额用量告警名称。	规则创建数量告警
QuotaActionCode	string	否	配额ID。	q_hvnoqv
QuotaDimensions	array	否	配额维度。
	object	否	配额维度。
Key	string	否	配额维度的Key。说明N的取值范围取决于对应云服务支持的维度个数。	regionId
Value	string	否	配额维度的Value。说明N的取值范围取决于对应云服务支持的维度个数。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	配额用量告警总数。	2
QuotaAlarms	array	配额用量告警详情。
	object
ThresholdPercent	number	配额用量告警阈值的百分比。	80
ThresholdType	string	配额告警类型。取值： used：已使用量告警。 usable：剩余可用量告警。	used
QuotaDimensions	object	配额维度。	{"regionId":"cn-hangzhou"}
CreateTime	string	创建配额用量告警的时间。	2020-11-27T07:23:34Z
QuotaActionCode	string	配额ID。	q_hvnoqv
AlarmName	string	告警名称。	规则创建数量告警
NotifyTarget	string	告警通知对象。取值：accountContact。	accountContact
NotifyChannels	array
	string	告警通知渠道。取值： sms：短消息。 email：电子邮件。	sms
QuotaUsage	number	已使用配额。	73
QuotaValue	number	配额值。	200
AlarmId	string	告警ID。	a2efa7fc-832f-47bb-8054-39e28012****
Threshold	number	配额用量告警阈值的数值。	160
ProductCode	string	云服务名称缩写。	config
WebHook	string	Webhook地址。	https://www.aliyun.com/webhook
ExceedThreshold	boolean	是否达到配额告警阈值。取值： false true	false
NextToken	string	用来标记当前调用返回读取到的位置。说明该参数返回为空，表示数据已读取完毕。	1
RequestId	string	请求ID。	87F3B755-3BD2-4C76-B36A-93247002918C
MaxResults	integer	本次请求返回的最大记录条数。	1

示例

请求示例

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

正常返回示例

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
}

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>

错误码

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