CreateAlarm
針對(duì)具有突發(fā)性或時(shí)間上不易預(yù)測(cè)的業(yè)務(wù),調(diào)用CreateAlarm創(chuàng)建一個(gè)報(bào)警任務(wù),該任務(wù)關(guān)聯(lián)云監(jiān)控指標(biāo)后,可以動(dòng)態(tài)調(diào)整伸縮組內(nèi)的ECS實(shí)例或ECI實(shí)例數(shù)量,并實(shí)時(shí)監(jiān)控實(shí)例指標(biāo),幫助您更好地管理和維護(hù)云資源。
接口說明
- 如果您創(chuàng)建自定義監(jiān)控類型的報(bào)警任務(wù)(MetricType=custom),您需要先將自定義監(jiān)控項(xiàng)指標(biāo)上報(bào)到云監(jiān)控。具體操作,請(qǐng)參見自定義監(jiān)控報(bào)警任務(wù)。
- 創(chuàng)建報(bào)警任務(wù)時(shí),您需要指定監(jiān)控項(xiàng)(MetricName),并配合維度信息(Dimension.N.DimensionKey和Dimension.N.DimensionValue),來確定伸縮組中該監(jiān)控項(xiàng)數(shù)據(jù)的聚合范圍。例如,指定user_id和scaling_group來確定聚合該用戶、該伸縮組下所有ECS實(shí)例或ECI實(shí)例的監(jiān)控項(xiàng)數(shù)據(jù)。
- 自定義監(jiān)控報(bào)警任務(wù)(MetricType=custom)的監(jiān)控項(xiàng)取決于您自有的監(jiān)控指標(biāo)。
- 系統(tǒng)監(jiān)控報(bào)警任務(wù)(MetricType=system)支持的監(jiān)控項(xiàng)的更多信息,請(qǐng)參見系統(tǒng)監(jiān)控報(bào)警任務(wù)。
Dimension.N.DimensionKey
和Dimension.N.DimensionValue
。調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | CreateAlarm | 系統(tǒng)規(guī)定參數(shù)。取值:CreateAlarm。 |
RegionId | String | 是 | cn-hangzhou | 伸縮組所屬的地域ID。 |
Name | String | 否 | TestAlarmTask | 報(bào)警任務(wù)的名稱。 |
Description | String | 否 | Test alarm task. | 報(bào)警任務(wù)的描述。 |
ScalingGroupId | String | 是 | asg-bp18p2yfxow2dloq**** | 報(bào)警任務(wù)關(guān)聯(lián)的伸縮組的ID。 |
MetricName | String | 否 | CpuUtilization | 監(jiān)控項(xiàng)名稱。取值范圍與報(bào)警任務(wù)的監(jiān)控類型有關(guān):
更多信息,請(qǐng)參見系統(tǒng)監(jiān)控報(bào)警任務(wù)。 |
MetricType | String | 否 | system | 監(jiān)控項(xiàng)類型。取值范圍:
|
Period | Integer | 否 | 300 | 統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的周期,單位:秒。取值范圍:
說明 僅ECS類型的伸縮組支持設(shè)置15秒的統(tǒng)計(jì)周期。 默認(rèn)值:300。 |
Statistics | String | 否 | Average | 統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的方法。取值范圍:
默認(rèn)值:Average。 |
Threshold | Float | 否 | 80.0 | 監(jiān)控指標(biāo)的閾值,滿足閾值表達(dá)式達(dá)到指定次數(shù)即觸發(fā)執(zhí)行伸縮規(guī)則。 |
ComparisonOperator | String | 否 | >= | 監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值的比較符,用于指定監(jiān)控項(xiàng)統(tǒng)計(jì)值與閾值在什么關(guān)系下滿足條件。取值范圍:
默認(rèn)值:>=。 |
EvaluationCount | Integer | 否 | 3 | 觸發(fā)執(zhí)行伸縮規(guī)則需要滿足閾值表達(dá)式的次數(shù),例如,CPU使用率平均值3次的統(tǒng)計(jì)結(jié)果均大于等于80%。 默認(rèn)值:3。 |
GroupId | Integer | 否 | 4055401 | 自定義監(jiān)控項(xiàng)所屬云監(jiān)控應(yīng)用分組的ID,僅在監(jiān)控項(xiàng)類型為custom時(shí)需要指定該參數(shù)。 |
Effective | String | 否 | TZ=+00 * * 1-2 * * ? | 指定報(bào)警任務(wù)的生效時(shí)間段,默認(rèn)所有時(shí)間都生效。 該參數(shù)遵循Cron表達(dá)式,默認(rèn)格式為
說明 該參數(shù)指定值默認(rèn)為UTC+8時(shí)區(qū),支持在Cron表達(dá)式之前添加時(shí)區(qū)信息 TZ=+yy 來指定時(shí)區(qū),其中y表示時(shí)區(qū)的數(shù)值。例如,TZ=+00 * * 1-2 * * ? 表示報(bào)警任務(wù)在UTC+0時(shí)區(qū)每天01:00~02:59之間生效。取值示例及含義如下:
|
AlarmAction.N | String | 否 | ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn**** | 報(bào)警任務(wù)關(guān)聯(lián)伸縮規(guī)則的唯一標(biāo)識(shí)符。 |
Dimension.N.DimensionKey | String | 否 | device | 監(jiān)控項(xiàng)關(guān)聯(lián)的維度信息鍵。取值范圍與報(bào)警任務(wù)的監(jiān)控類型有關(guān):
|
Dimension.N.DimensionValue | String | 否 | eth0 | 監(jiān)控項(xiàng)關(guān)聯(lián)的維度信息值,取值范圍由Dimension.N.DimensionKey決定:
|
Expression.N.MetricName | String | 否 | CpuUtilization | 多指標(biāo)報(bào)警規(guī)則的監(jiān)控指標(biāo)名稱。取值范圍與報(bào)警任務(wù)的監(jiān)控類型有關(guān):
更多信息,請(qǐng)參見系統(tǒng)監(jiān)控報(bào)警任務(wù)。 |
Expression.N.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)值:>=。 |
Expression.N.Period | Integer | 否 | 900 | 多指標(biāo)報(bào)警規(guī)則中統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的周期,單位:秒。取值范圍:
說明 僅ECS類型的伸縮組支持設(shè)置15秒的統(tǒng)計(jì)周期。 默認(rèn)值:300。 |
Expression.N.Statistics | String | 否 | Average | 多指標(biāo)報(bào)警規(guī)則中統(tǒng)計(jì)監(jiān)控項(xiàng)數(shù)據(jù)的方法。取值范圍:
默認(rèn)值:Average。 |
Expression.N.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)系。取值范圍:
默認(rèn)值: |
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
AlarmTaskId | String | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 報(bào)警任務(wù)ID。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 請(qǐng)求ID。 |
示例
請(qǐng)求示例
http(s)://ess.aliyuncs.com/?Action=CreateAlarm
&RegionId=cn-hangzhou
&Name=TestAlarmTask
&Description=Test alarm task.
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&MetricName=CpuUtilization
&MetricType=system
&Period=300
&Statistics=Average
&Threshold=80.0
&ComparisonOperator=>=
&EvaluationCount=3
&GroupId=4055401
&Effective=TZ=+00 * * 1-2 * * ?
&AlarmAction=["ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****"]
&Dimension=[{"DimensionKey":"device","DimensionValue":"eth0"}]
&Expression=[{"MetricName":"CpuUtilization","ComparisonOperator":">=","Period":900,"Statistics":"Average","Threshold":40.0}]
&ExpressionsLogicOperator=&&
&公共請(qǐng)求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateAlarmResponse>
<AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateAlarmResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"AlarmTaskId" : "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
HttpCode |
錯(cuò)誤碼 |
錯(cuò)誤信息 |
描述 |
404 |
InvalidParameter |
The specified value of parameter "%s" is not valid. |
指定參數(shù)“%s”不合法。 |