調用API DescribeAlarms查詢報警任務信息,及時了解已有報警任務的配置和監控項數據的變化趨勢,幫助您實時發現系統資源異常,確保系統的穩定性和可靠性。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ess:DescribeAlarms | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 報警任務所屬地域的 ID。 | cn-qingdao |
ScalingGroupId | string | 否 | 報警任務關聯的伸縮組的 ID。 | asg-bp18p2yfxow2dloq**** |
AlarmTaskId | string | 否 | 報警任務 ID。 | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** |
State | string | 否 | 報警任務的狀態。取值范圍:
| OK |
IsEnable | boolean | 否 | 報警任務是否啟用。取值范圍:
| true |
MetricType | string | 否 | 監控項類型。取值范圍:
| system |
MetricName | string | 否 | 監控項名稱。 | CpuUtilization |
PageSize | integer | 否 | 分頁查詢時設置的每頁行數。最大值:50。 默認值:10。 | 10 |
PageNumber | integer | 否 | 伸縮規則列表的頁碼,起始值:1。 默認值:1。 | 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "871C7C53-34A4-45AA-8C14-4B72FA6A****",
"PageNumber": 1,
"TotalCount": 2,
"AlarmList": [
{
"AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
"MetricName": "CpuUtilization",
"EvaluationCount": 3,
"State": "ALARM",
"Period": 300,
"ScalingGroupId": "asg-bp18p2yfxow2dloq****",
"ComparisonOperator": ">=",
"Effective": "* * * * * ?",
"Description": "Test alarm task.",
"MetricType": "system",
"Name": "TestAlarmTask",
"Threshold": 80,
"Enable": true,
"Statistics": "Average",
"Dimensions": [
{
"DimensionKey": "device",
"DimensionValue": "eth0"
}
],
"AlarmActions": [
"ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****"
],
"Expressions": [
{
"MetricName": "CpuUtilization",
"ComparisonOperator": ">=",
"Period": 900,
"Statistics": "Average",
"Threshold": 40
}
],
"ExpressionsLogicOperator": "&&",
"HybridMonitorNamespace": "",
"HybridMetrics": [
{
"Id": "",
"Expression": "",
"MetricName": "",
"Statistic": "",
"Dimensions": [
{
"DimensionKey": "",
"DimensionValue": ""
}
]
}
],
"PromQL": ""
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-13 | OpenAPI 返回結構發生變更 | 查看變更詳情 |