針對具有突發性或時間上不易預測的業務,調用CreateAlarm創建一個報警任務,該任務關聯云監控指標后,可以動態調整伸縮組內的ECS實例或ECI實例數量,并實時監控實例指標,幫助您更好地管理和維護云資源。
接口說明
- 如果您創建自定義監控類型的報警任務(MetricType=custom),您需要先將自定義監控項指標上報到云監控。具體操作,請參見自定義監控報警任務。
- 創建報警任務時,您需要指定監控項(MetricName),并配合維度信息(Dimensions.DimensionKey 和 Dimensions.DimensionValue),來確定伸縮組中該監控項數據的聚合范圍。例如,指定 user_id 和 scaling_group 來確定聚合該用戶、該伸縮組下所有 ECS 實例或 ECI 實例的監控項數據。
- 自定義監控報警任務(MetricType=custom)的監控項取決于您自有的監控指標。
- 系統監控報警任務(MetricType=system)支持的監控項的更多信息,請參見系統監控報警任務。
Dimensions.DimensionKey
和Dimensions.DimensionValue
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ess:CreateAlarm | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 伸縮組所屬的地域 ID。 | cn-hangzhou |
Name | string | 否 | 報警任務的名稱。 | TestAlarmTask |
Description | string | 否 | 報警任務的描述。 | Test alarm task. |
ScalingGroupId | string | 是 | 報警任務關聯的伸縮組的 ID。 | asg-bp18p2yfxow2dloq**** |
MetricName | string | 否 | 監控項名稱。取值范圍與報警任務的監控類型有關:
更多信息,請參見系統監控報警任務。 | CpuUtilization |
MetricType | string | 否 | 監控項類型。取值范圍:
| system |
Period | integer | 否 | 統計監控項數據的周期,單位:秒。取值范圍:
說明
僅 ECS 類型的伸縮組支持設置 15 秒的統計周期。
默認值:300。 | 300 |
Statistics | string | 否 | 統計監控項數據的方法。取值范圍:
默認值:Average。 | Average |
Threshold | float | 否 | 監控指標的閾值,滿足閾值表達式達到指定次數即觸發執行伸縮規則。 | 80.0 |
ComparisonOperator | string | 否 | 監控項統計值與閾值的比較符,用于指定監控項統計值與閾值在什么關系下滿足條件。取值范圍:
默認值:>=。 | >= |
EvaluationCount | integer | 否 | 觸發執行伸縮規則需要滿足閾值表達式的次數,例如,CPU 使用率平均值 3 次的統計結果均大于等于 80%。 默認值:3。 | 3 |
GroupId | integer | 否 | 自定義監控項所屬云監控應用分組的 ID,僅在監控項類型為 custom 時需要指定該參數。 | 4055401 |
Effective | string | 否 | 指定報警任務的生效時間段,默認所有時間都生效。 該參數遵循 Cron 表達式,默認格式為
說明
該參數指定值默認為 UTC+8 時區,支持在 Cron 表達式之前添加時區信息 TZ=+yy 來指定時區,其中 y 表示時區的數值。例如,TZ=+00 * * 1-2 * * ? 表示報警任務在 UTC+0 時區每天 01:00~02:59 之間生效。
取值示例及含義如下:
| TZ=+00 * * 1-2 * * ? |
AlarmActions | array | 否 | 報警任務關聯伸縮規則的唯一標識符的列表。 | |
string | 否 | 報警任務關聯伸縮規則的唯一標識符的列表。 | ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn**** | |
Dimensions | array<object> | 否 | 監控項關聯的維度信息。 | |
object | 否 | 監控項關聯的維度信息。 | ||
DimensionKey | string | 否 | 監控項關聯的維度信息鍵,取值范圍與報警任務的監控類型有關:
| device |
DimensionValue | string | 否 | 監控項關聯的維度信息值,取值范圍由 Dimensions.DimensionKey 決定:
| eth0 |
Expressions | array<object> | 否 | 多指標報警規則相關信息。 | |
object | 否 | 多指標報警規則相關信息。 | ||
MetricName | string | 否 | 多指標報警規則的監控指標名稱。取值范圍與報警任務的監控類型有關:
更多信息,請參見系統監控報警任務。 | CpuUtilization |
ComparisonOperator | string | 否 | 多指標報警規則的監控項統計值與閾值的比較符,用于指定監控項統計值與閾值在什么關系下滿足條件。取值范圍:
默認值:>=。 | >= |
Period | integer | 否 | 多指標報警規則中統計監控項數據的周期,單位:秒。取值范圍:
說明
僅 ECS 類型的伸縮組支持設置 15 秒的統計周期。
默認值:300。 | 900 |
Statistics | string | 否 | 多指標報警規則中統計監控項數據的方法。取值范圍:
默認值:Average。 | Average |
Threshold | float | 否 | 多指標報警規則中監控指標的閾值,滿足閾值表達式達到指定次數即觸發執行伸縮規則。 | 40.0 |
ExpressionsLogicOperator | string | 否 | 多指標報警條件之間的關系。取值范圍:
默認值: | && |
返回參數
示例
正常返回示例
JSON
格式
{
"AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|