呼叫 CreateGroupMetricRules 介面批量為指定應用分組建立報警規則。
介面說明
本文將提供一個示例,為應用分組123456中的雲端伺服器 ECS 的監控項cpu_total建立一條報警規則,其中報警規則 ID 為456789,報警規則名稱為ECS_Rule1,報警級別為Critical,報警統計方法為Average,報警閾值比較符為GreaterThanOrEqualToThreshold,報警閾值為90,報警重試次數為3。返回結果顯示,報警規則ECS_Rule1建立成功。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cms:CreateGroupMetricRules |
create |
*GroupMetricRule
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| GroupId |
integer |
是 |
應用分組 ID。 關於如何取得應用分組 ID,請參見 DescribeMonitorGroups 。 |
3607**** |
| GroupMetricRules |
array<object> |
否 |
應用分組的監控項規則列表。 |
|
|
array<object> |
否 |
應用分組的監控項規則。 |
||
| Escalations.Info.Threshold |
string |
否 |
普通級別報警閾值。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
10 |
| MetricName |
string |
是 |
監控項名稱。 N 的取值範圍:1~200。 關於如何取得監控項名稱,請參見 DescribeMetricMetaList 或雲端產品監控項。 |
cpu_total |
| Escalations.Warn.Threshold |
string |
否 |
警告級別報警閾值。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
20 |
| EffectiveInterval |
string |
否 |
報警規則的生效時間範圍。N 的取值範圍:1~200。 |
05:31-23:59 |
| NoEffectiveInterval |
string |
否 |
報警規則的失效時間範圍。N 的取值範圍:1~200。 |
00:00-05:30 |
| RuleId |
string |
是 |
報警規則 ID。 N 的取值範圍:1~200。 |
456789 |
| Escalations.Critical.Times |
integer |
否 |
傳送緊急報警通知需要監控指標達到報警閾值的次數。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
3 |
| Dimensions |
string |
否 |
指定資源的監控維度。 格式: |
[{"instanceId":"i-m5e1qg6uo38rztr4****"}] |
| Escalations.Critical.Threshold |
string |
否 |
觸發緊急級別報警通知的閾值。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
90 |
| Escalations.Critical.Statistics |
string |
否 |
緊急級別報警統計方法。 N 的取值範圍:1~200。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| Escalations.Warn.ComparisonOperator |
string |
否 |
警告級別閾值比較符。取值:
N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Escalations.Info.Times |
integer |
否 |
傳送普通報警通知需要監控指標達到報警閾值的次數。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
1 |
| SilenceTime |
integer |
否 |
報警通知的沉默週期。N 的取值範圍:1~200。 單位:秒。預設值:86400。最小值:3600。 |
86400 |
| Webhook |
string |
否 |
報警發生回呼時的 URL 地址。N 的取值範圍:1~200。 填寫公網可存取的 URL 地址,雲端監控會將報警資訊透過 POST 請求推送到該地址,目前僅支援 HTTP 協議。 |
https://www.aliyun.com |
| Namespace |
string |
是 |
雲端產品的資料命名空間。 N 的取值範圍:1~200。 關於如何取得雲端產品的資料命名空間,請參見 DescribeMetricMetaList 或雲端產品監控項。 |
acs_ecs_dashboard |
| EmailSubject |
string |
否 |
報警郵件主題。 N 的取值範圍:1~200。 |
ECS instance |
| Period |
string |
否 |
監控資料的上報週期。 N 的取值範圍:1~200。
|
60 |
| RuleName |
string |
是 |
報警規則名稱。 N 的取值範圍:1~200。 |
ECS_Rule1 |
| Escalations.Info.Statistics |
string |
否 |
普通級別報警統計方法。 N 的取值範圍:1~200。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| Escalations.Warn.Times |
integer |
否 |
傳送警告報警通知需要監控指標達到報警閾值的次數。 N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
3 |
| Escalations.Info.ComparisonOperator |
string |
否 |
普通級別閾值比較符。取值:
N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Interval |
string |
否 |
報警規則的探測週期。 N 的取值範圍:1~200。 單位:秒。秒預設為監控項的最小頻率。 說明
建議報警規則的探測週期和資料上報週期保持一致。如果報警規則的探測週期小於資料上報週期,會因為資料不足而不能觸發報警。 |
60 |
| Category |
string |
是 |
雲端產品名稱縮寫。 N 的取值範圍:1~200。 關於如何取得雲端產品名稱縮寫,請參見 DescribeProjectMeta 介面的返回參數 |
ECS |
| Escalations.Critical.ComparisonOperator |
string |
否 |
緊急級別閾值比較符。取值:
N 的取值範圍:1~200。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Escalations.Warn.Statistics |
string |
否 |
警告級別報警統計方法。 N 的取值範圍:1~200。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| NoDataPolicy |
string |
否 |
無監控資料時報警的處理方式。取值:
N 的取值範圍:1~200。 |
KEEP_LAST_STATE |
| ContactGroups |
string |
否 |
報警聯絡人組。 N 的取值範圍:1~200。 關於如何取得報警聯絡人組,請參見 DescribeContactGroupList 。 |
ECS_Group |
| Labels |
array<object> |
否 |
報警規則的標籤鍵。 |
|
|
object |
否 |
報警規則的標籤鍵。 |
||
| Key |
string |
否 |
報警規則的標籤鍵。報警通知中會包含標籤。 N 的取值範圍:1~200。 |
key1 |
| Value |
string |
否 |
報警規則的標籤值。報警通知中會包含標籤。 N 的取值範圍:1~200。 |
value1 |
| Options |
string |
否 |
進階設定。 格式:{"key1":"value1","key2":"value2"},例如:{"NotSendOK":true},表示是否傳送報警恢復通知,key 為 NotSendOK,value 為 true(不傳送)或 false(預設傳送)。 |
{ "NotSendOK": true } |
關於公共請求參數的詳情,請參見公共參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Code |
integer |
狀態碼。 說明
200 表示成功。 |
200 |
| Message |
string |
報錯資訊。 |
The Request is not authorization. |
| RequestId |
string |
請求 ID。 |
461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D |
| Success |
boolean |
操作是否成功。取值:
|
true |
| Resources |
object |
||
| AlertResult |
array<object> |
報警規則列表。 |
|
|
object |
|||
| Code |
integer |
新建立告警規則的狀態碼。 說明
200 表示成功。 |
200 |
| Message |
string |
新建立告警規則的錯誤資訊。 |
Metric not found. |
| Success |
boolean |
新建立告警規則是否成功。取值:
|
true |
| RuleName |
string |
新建立告警規則的名稱。 |
ECS_Rule1 |
| RuleId |
string |
新建立告警規則的 ID。 |
456789 |
樣本
正常返回樣本
JSON格式
{
"Code": 200,
"Message": "The Request is not authorization.",
"RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
"Success": true,
"Resources": {
"AlertResult": [
{
"Code": 200,
"Message": "Metric not found.",
"Success": true,
"RuleName": "ECS_Rule1",
"RuleId": "456789"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | %s | %s | |
| 412 | %s | %s | |
| 500 | %s | %s | |
| 500 | 500 | %s | |
| 403 | %s | %s | |
| 404 | %s | %s | |
| 409 | %s | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。