針對具有突發性或時間上不易預測的業務,調用CreateAlarm建立一個警示任務,該任務關聯CloudMonitor指標後,可以動態調整伸縮組內的ECS執行個體或ECI執行個體數量,並即時監控執行個體指標,協助您更好地管理和維護雲資源。
介面說明
- 如果您建立自訂監控類型的警示任務(MetricType=custom),您需要先將自訂監控項指標上報到CloudMonitor。具體操作,請參見自訂監控警示任務。
- 建立警示任務時,您需要指定監控項(MetricName),並配合維度資訊(Dimension.N.DimensionKey和Dimension.N.DimensionValue),來確定伸縮組中該監控項資料的彙總範圍。例如,指定user_id和scaling_group來確定彙總該使用者、該伸縮組下所有ECS執行個體或ECI執行個體的監控項資料。
- 自訂監控警示任務(MetricType=custom)的監控項取決於您自有的監控指標。
- 系統監控警示任務(MetricType=system)支援的監控項的更多資訊,請參見系統監控警示任務。
Dimension.N.DimensionKey和Dimension.N.DimensionValue。調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
| Action | String | 是 | CreateAlarm | 系統規定參數。取值:CreateAlarm。 |
| RegionId | String | 是 | cn-hangzhou | 伸縮組所屬的地區ID。 |
| Name | String | 否 | TestAlarmTask | 警示任務的名稱。 |
| Description | String | 否 | Test alarm task. | 警示任務的描述。 |
| ScalingGroupId | String | 是 | asg-bp18p2yfxow2dloq**** | 警示任務關聯的伸縮組的ID。 |
| MetricName | String | 否 | CpuUtilization | 監控項名稱。取值範圍與警示任務的監控類型有關:
更多資訊,請參見系統監控警示任務。 |
| MetricType | String | 否 | system | 監控項類型。取值範圍:
|
| Period | Integer | 否 | 300 | 統計監控項資料的周期,單位:秒。取值範圍:
說明 僅ECS類型的伸縮組支援設定15秒的統計周期。 預設值:300。 |
| Statistics | String | 否 | Average | 統計監控項資料的方法。取值範圍:
預設值:Average。 |
| Threshold | Float | 否 | 80.0 | 監控指標的閾值,滿足閾值運算式達到指定次數即觸發執行伸縮規則。 |
| ComparisonOperator | String | 否 | >= | 監控項統計值與閾值的比較符,用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍:
預設值:>=。 |
| EvaluationCount | Integer | 否 | 3 | 觸發執行伸縮規則需要滿足閾值運算式的次數,例如,CPU使用率平均值3次的統計結果均大於等於80%。 預設值:3。 |
| GroupId | Integer | 否 | 4055401 | 自訂監控項所屬CloudMonitor應用分組的ID,僅在監控項類型為custom時需要指定該參數。 |
| Effective | String | 否 | TZ=+00 * * 1-2 * * ? | 指定警示任務的生效時間段,預設所有時間都生效。 該參數遵循Cron運算式,預設格式為
說明 該參數指定值預設為UTC+8時區,支援在Cron運算式之前添加時區資訊 TZ=+yy來指定時區,其中y表示時區的數值。例如,TZ=+00 * * 1-2 * * ?表示警示任務在UTC+0時區每天01:00~02:59之間生效。取值樣本及含義如下:
|
| AlarmAction.N | String | 否 | ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn**** | 警示任務關聯伸縮規則的唯一識別碼。 |
| Dimension.N.DimensionKey | String | 否 | device | 監控項關聯的維度資訊鍵。取值範圍與警示任務的監控類型有關:
|
| Dimension.N.DimensionValue | String | 否 | eth0 | 監控項關聯的維度資訊值,取值範圍由Dimension.N.DimensionKey決定:
|
| Expression.N.MetricName | String | 否 | CpuUtilization | 多指標警示規則的監控指標名稱。取值範圍與警示任務的監控類型有關:
更多資訊,請參見系統監控警示任務。 |
| Expression.N.ComparisonOperator | String | 否 | >= | 多指標警示規則的監控項統計值與閾值的比較符,用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍:
預設值:>=。 |
| Expression.N.Period | Integer | 否 | 900 | 多指標警示規則中統計監控項資料的周期,單位:秒。取值範圍:
說明 僅ECS類型的伸縮組支援設定15秒的統計周期。 預設值:300。 |
| Expression.N.Statistics | String | 否 | Average | 多指標警示規則中統計監控項資料的方法。取值範圍:
預設值:Average。 |
| Expression.N.Threshold | Float | 否 | 40.0 | 多指標警示規則中監控指標的閾值,滿足閾值運算式達到指定次數即觸發執行伸縮規則。 |
| ExpressionsLogicOperator | String | 否 | && | 多指標警示條件之間的關係。取值範圍:
預設值: |
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| AlarmTaskId | String | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 警示任務ID。 |
| RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 請求ID。 |
樣本
請求樣本
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=&&
&公用請求參數
正常返回樣本
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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
HttpCode |
錯誤碼 |
錯誤資訊 |
描述 |
404 |
InvalidParameter |
The specified value of parameter "%s" is not valid. |
指定參數“%s”不合法。 |