如果伸縮組當前的報警任務不再滿足需求,您可以調用API ModifyAlarm修改一項或者多項報警任務屬性,而無需重新創建新的報警任務,避免不必要的重復操作,節約時間和資源成本。
接口說明
- 如果您創建自定義監控類型的報警任務(MetricType=custom),您需要先將自定義監控項指標上報到云監控。具體操作,請參見自定義監控報警任務。
- 創建報警任務時,您需要指定監控項(MetricName),并配合維度信息(
Dimension.N.DimensionKey
和Dimension.N.DimensionValue
),來確定伸縮組中該監控項數據的聚合范圍。例如,指定user_id
和scaling_group
來確定聚合該用戶、該伸縮組下所有ECS實例或ECI實例的監控項數據。- 自定義監控報警任務(MetricType=custom)的監控項取決于您自有的監控指標。
- 系統監控報警任務(MetricType=system)支持的監控項的更多信息,請參見系統監控報警任務。
user_id
和scaling_group
由系統自動填充,device
、
state
需要您手動指定。更多信息,請參見參數Dimension.N.DimensionKey
和Dimension.N.DimensionValue
。調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ModifyAlarm | 系統規定參數。取值:ModifyAlarm。 |
RegionId | String | 是 | cn-qingdao | 報警任務所屬地域的ID。 |
AlarmTaskId | String | 是 | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 報警任務的ID。 |
Name | String | 否 | alarmtask**** | 報警任務的名稱。 |
Description | String | 否 | Test alarm task. | 報警任務的描述。 |
MetricName | String | 否 | MemoryUtilization | 監控項名稱。取值范圍與報警任務的監控類型有關:
更多信息,請參見系統監控報警任務。 |
MetricType | String | 否 | system | 監控項類型。取值范圍:
|
Period | Integer | 否 | 300 | 統計監控項數據的周期,單位:秒。取值范圍:
|
Statistics | String | 否 | Average | 統計監控項數據的方法。取值范圍:
|
Threshold | Float | 否 | 80 | 監控指標的閾值,滿足閾值表達式達到指定次數即觸發執行伸縮規則。 |
ComparisonOperator | String | 否 | >= | 監控項統計值與閾值的比較符,用于指定監控項統計值與閾值在什么關系下滿足條件。取值范圍:
|
EvaluationCount | Integer | 否 | 3 | 觸發執行伸縮規則需要滿足閾值表達式的次數。 例如,CPU使用率平均值3次的統計結果均大于等于80%。 |
GroupId | Integer | 否 | 4055401 | 自定義監控項所屬云監控應用分組的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:140692647****: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 | 否 | 300 | 多指標報警規則中統計監控項數據的周期,單位:秒。取值范圍:
默認值:300。 |
Expression.N.Statistics | String | 否 | Average | 多指標報警規則中統計監控項數據的方法。取值范圍:
|
Expression.N.Threshold | Float | 否 | 40.0 | 多指標報警規則中監控指標的閾值,滿足閾值表達式達到指定次數即觸發執行伸縮規則。 |
ExpressionsLogicOperator | String | 否 | && | 多指標報警條件之間的關系。取值范圍:
默認值: |
返回數據
名稱 |
類型 |
示例值 |
描述 |
AlarmTaskId | String | asg-bp1hvbnmkl10vll5**** | 報警任務ID。 |
RequestId | String | BACACF83-7070-4953-A8FD-D81F89F1**** | 請求ID。 |
示例
請求示例
http(s)://ess.aliyuncs.com/?Action=ModifyAlarm
&RegionId=cn-qingdao
&AlarmTaskId=asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
&Name=alarmtask****
&Description=Test alarm task.
&MetricName=MemoryUtilization
&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:140692647****:scalingrule/asr-bp163l21e07uhn****"]
&Dimension=[{"DimensionKey":"device","DimensionValue":"eth0"}]
&Expression=[{"MetricName":"CpuUtilization","ComparisonOperator":">=","Period":300,"Statistics":"Average","Threshold":40.0}]
&ExpressionsLogicOperator=&&
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyAlarmResponse>
<AlarmTaskId>asg-bp1hvbnmkl10vll5****</AlarmTaskId>
<RequestId>BACACF83-7070-4953-A8FD-D81F89F1****</RequestId>
</ModifyAlarmResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"AlarmTaskId" : "asg-bp1hvbnmkl10vll5****",
"RequestId" : "BACACF83-7070-4953-A8FD-D81F89F1****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。