查詢配額用量警示列表。
介面說明
配額警示功能已升級,本 API 即將廢棄,本 API 僅可查詢舊版配額用量警示列表,若您想查詢新版配額用量警示列表,請您使用CloudMonitor API DescribeMetricRuleList 進行操作。使用 API 對新版配額警示進行操作的更多資訊,請參見使用 API 管理新版配額警示。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
quotas:ListQuotaAlarms |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| NextToken |
string |
否 |
用來標記開始讀取資料的位置。 說明
不設定該參數,表示從頭開始。 |
1 |
| MaxResults |
integer |
否 |
本次讀取的最大記錄條數。 取值範圍:1~200。預設值:30。 |
20 |
| ProductCode |
string |
否 |
雲產品的縮寫名稱。 說明
關於如何擷取雲產品的縮寫名稱,請參見 ListProductQuotas 中的 |
ecs |
| AlarmName |
string |
否 |
配額用量警示名稱。 |
q_hvnoqv alarm |
| QuotaActionCode |
string |
否 |
配額 ID。 說明
|
q_hvnoqv |
| QuotaDimensions |
array<object> |
否 |
配額維度。 |
|
|
object |
否 |
配額維度。 |
||
| Key |
string |
否 |
配額維度 Key。 說明
|
regionId |
| Value |
string |
否 |
配額維度 Key。 說明
|
cn-hangzhou |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
無。 |
||
| MaxResults |
integer |
本次請求返回的最大記錄條數。 |
1 |
| NextToken |
string |
用來標記當前調用返回讀取到的位置。 說明
該參數返回為空白,表示資料已讀取完畢。 |
1 |
| QuotaAlarms |
array<object> |
配額用量警示詳情。 |
|
|
array<object> |
配額用量警示詳情。 |
||
| AlarmId |
string |
警示 ID。 |
a2efa7fc-832f-47bb-8054-39e28012**** |
| AlarmName |
string |
警示名稱。 |
q_hvnoqv alarm |
| CreateTime |
string |
建立配額用量警示的時間。 |
2020-11-27T07:23:34Z |
| ExceedThreshold |
boolean |
是否達到配額警示閾值。取值:
|
false |
| NotifyChannels |
array |
配額警示通知渠道。 |
|
|
string |
警示通知渠道。取值:
|
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 |
| 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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。