DescribeAlarms
調(diào)用API DescribeAlarms查詢報(bào)警任務(wù)信息,及時(shí)了解已有報(bào)警任務(wù)的配置和監(jiān)控項(xiàng)數(shù)據(jù)的變化趨勢(shì),幫助您實(shí)時(shí)發(fā)現(xiàn)系統(tǒng)資源異常,確保系統(tǒng)的穩(wěn)定性和可靠性。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeAlarms | 系統(tǒng)規(guī)定參數(shù)。取值:DescribeAlarms。 |
RegionId | String | 是 | cn-qingdao | 報(bào)警任務(wù)所屬地域的ID。 |
ScalingGroupId | String | 否 | asg-bp18p2yfxow2dloq**** | 報(bào)警任務(wù)關(guān)聯(lián)的伸縮組的ID。 |
AlarmTaskId | String | 否 | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 報(bào)警任務(wù)ID。 |
State | String | 否 | OK | 報(bào)警任務(wù)的狀態(tài)。取值范圍:
|
IsEnable | Boolean | 否 | true | 報(bào)警任務(wù)是否啟用。取值范圍:
|
MetricType | String | 否 | system | 監(jiān)控項(xiàng)類型。取值范圍:
|
MetricName | String | 否 | CpuUtilization | 監(jiān)控項(xiàng)名稱。 |
PageSize | Integer | 否 | 10 | 分頁(yè)查詢時(shí)設(shè)置的每頁(yè)行數(shù)。最大值:50。 默認(rèn)值:10。 |
PageNumber | Integer | 否 | 1 | 報(bào)警任務(wù)列表的頁(yè)碼。起始值:1。 默認(rèn)值:1。 |
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
PageSize | Integer | 10 | 每頁(yè)行數(shù)。 |
RequestId | String | 871C7C53-34A4-45AA-8C14-4B72FA6A**** | 請(qǐng)求ID。 |
PageNumber | Integer | 1 | 當(dāng)前頁(yè)碼。 |
TotalCount | Integer | 2 | 報(bào)警任務(wù)的總數(shù)。 |
AlarmList | Array of Alarm | 報(bào)警任務(wù)的列表。 |
|
Alarm | |||
AlarmTaskId | String | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 報(bào)警任務(wù)ID。 |
MetricName | String | CpuUtilization | 監(jiān)控項(xiàng)名稱。可能值:
更多信息,請(qǐng)參見系統(tǒng)監(jiān)控報(bào)警任務(wù)。 |
EvaluationCount | Integer | 3 | 觸發(fā)執(zhí)行伸縮規(guī)則需要滿足閾值表達(dá)式的次數(shù),例如,CPU使用率平均值3次的統(tǒng)計(jì)結(jié)果均大于等于80%。 |
State | String | ALARM | 報(bào)警任務(wù)的狀態(tài)。可能值:
|
Period | Integer | 300 | 統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的周期,單位為秒。可能值:
說(shuō)明 僅ECS類型的伸縮組支持設(shè)置15秒的統(tǒng)計(jì)周期。 |
ScalingGroupId | String | asg-bp18p2yfxow2dloq**** | 報(bào)警任務(wù)關(guān)聯(lián)的伸縮組的ID。 |
ComparisonOperator | String | >= | 監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值的比較符,用于指定監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值在什么關(guān)系下滿足條件。可能值:
|
Effective | String | * * * * * ? | 指定報(bào)警任務(wù)的生效時(shí)間段。 |
Description | String | Test alarm task. | 報(bào)警任務(wù)的描述。 |
MetricType | String | system | 監(jiān)控項(xiàng)類型。可能值:
|
Name | String | TestAlarmTask | 報(bào)警任務(wù)的名稱。 |
Threshold | Float | 80.0 | 監(jiān)控指標(biāo)的閾值,滿足閾值表達(dá)式達(dá)到指定次數(shù)即觸發(fā)執(zhí)行伸縮規(guī)則。 |
Enable | Boolean | true | 報(bào)警任務(wù)是否啟用。可能值:
|
Statistics | String | Average | 統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的方法。可能值:
|
Dimensions | Array of Dimension | 監(jiān)控項(xiàng)關(guān)聯(lián)的維度信息。 |
|
Dimension | |||
DimensionKey | String | device | 監(jiān)控項(xiàng)關(guān)聯(lián)的維度信息鍵,可能值:
|
DimensionValue | String | eth0 | 監(jiān)控項(xiàng)關(guān)聯(lián)的維度信息值,可能值由維度信息鍵決定。
-
|
AlarmActions | Array of String | ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh**** | 報(bào)警任務(wù)關(guān)聯(lián)伸縮規(guī)則的唯一標(biāo)識(shí)符的列表。 |
Expressions | Array of Expression | 多指標(biāo)報(bào)警規(guī)則的相關(guān)信息。 |
|
Expression | |||
MetricName | String | CpuUtilization | 多指標(biāo)報(bào)警規(guī)則的監(jiān)控指標(biāo)名稱。可能值:
更多信息,請(qǐng)參見系統(tǒng)監(jiān)控報(bào)警任務(wù)。 |
ComparisonOperator | String | >= | 多指標(biāo)報(bào)警規(guī)則的監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值的比較符,用于指定監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值在什么關(guān)系下滿足條件。可能值:
默認(rèn)值:>=。 |
Period | Integer | 900 | 多指標(biāo)報(bào)警規(guī)則中統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的周期,單位為秒。可能值:
說(shuō)明 僅ECS類型的伸縮組支持設(shè)置15秒的統(tǒng)計(jì)周期。 |
Statistics | String | Average | 多指標(biāo)報(bào)警規(guī)則中統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的方法。可能值:
|
Threshold | Float | 40.0 | 多指標(biāo)報(bào)警規(guī)則中監(jiān)控指標(biāo)的閾值,滿足閾值表達(dá)式達(dá)到指定次數(shù)即觸發(fā)執(zhí)行伸縮規(guī)則。 |
ExpressionsLogicOperator | String | && | 多指標(biāo)報(bào)警條件之間的關(guān)系。可能值:
|
示例
請(qǐng)求示例
http(s)://ess.aliyuncs.com/?Action=DescribeAlarms
&RegionId=cn-qingdao
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&AlarmTaskId=asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
&State=OK
&IsEnable=true
&MetricType=system
&MetricName=CpuUtilization
&PageSize=10
&PageNumber=1
&公共請(qǐng)求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAlarmsResponse>
<PageSize>10</PageSize>
<RequestId>871C7C53-34A4-45AA-8C14-4B72FA6A****</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<AlarmList>
<AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>
<MetricName>CpuUtilization</MetricName>
<EvaluationCount>3</EvaluationCount>
<State>ALARM</State>
<Period>300</Period>
<ScalingGroupId>asg-bp18p2yfxow2dloq****</ScalingGroupId>
<ComparisonOperator>>=</ComparisonOperator>
<Effective>* * * * * ?</Effective>
<Description>Test alarm task.</Description>
<MetricType>system</MetricType>
<Name>TestAlarmTask</Name>
<Threshold>80</Threshold>
<Enable>true</Enable>
<Statistics>Average</Statistics>
<Dimensions>
<DimensionKey>device</DimensionKey>
<DimensionValue>eth0</DimensionValue>
</Dimensions>
<AlarmActions>ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****</AlarmActions>
<Expressions>
<MetricName>CpuUtilization</MetricName>
<ComparisonOperator>>=</ComparisonOperator>
<Period>900</Period>
<Statistics>Average</Statistics>
<Threshold>40</Threshold>
</Expressions>
<ExpressionsLogicOperator>&&</ExpressionsLogicOperator>
</AlarmList>
</DescribeAlarmsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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" : "&&"
} ]
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。