呼叫 PutResourceMetricRules 介面為指定資源的指定監控項設置多條閾值報警規則。
介面說明
本文將提供一個示例,為雲端伺服器 ECS acs_ecs_dashboard 的執行個體 i-uf6j91r34rnwawoo**** 中的監控項 cpu_total 設置閾值報警規則。該報警規則的報警聯繫組為 ECS_Group、報警規則名稱為 test123、報警規則 ID 為 a151cd6023eacee2f0978e03863cc1697c89508****、Critical 級別的統計方法為 Average、Critical 級別的比較符為 GreaterThanOrEqualToThreshold、Critical 級別的閾值為 90 和 Critical 級別的報警重試次數為 3。
2024-08-15 增加 Statistics 校驗,統計值只能填對應指標的 Statistics。關於如何取得該參數的取值,請參見雲端產品監控項。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cms:PutResourceMetricRules |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Rules |
array<object> |
是 |
閾值報警規則列表。 N 的取值範圍:1~50。 |
|
|
array<object> |
否 |
無。 |
||
| Escalations.Info.Threshold |
string |
否 |
Info 級別報警閾值。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
90 |
| MetricName |
string |
否 |
監控項名稱。 N 的取值範圍:1~50。 關於如何查詢監控項名稱,請參見雲端產品監控項。 |
cpu_total |
| Escalations.Warn.Threshold |
string |
否 |
Warn 級別報警閾值。 N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
90 |
| EffectiveInterval |
string |
否 |
報警規則的生效時間範圍。 N 的取值範圍:1~50。 |
00:00-23:59 |
| NoEffectiveInterval |
string |
否 |
報警規則的失效時間範圍。 N 的取值範圍:1~50。 |
00:00-06:00 |
| RuleId |
string |
是 |
報警規則 ID。 N 的取值範圍:1~50。 您可以輸入新的報警規則 ID,也可以使用雲端監控已存在的報警規則 ID。關於如何查詢報警規則 ID,請參見 DescribeMetricRuleList 。 說明
輸入新的報警規則 ID,表示建立一條閾值報警規則。 |
a151cd6023eacee2f0978e03863cc1697c89508**** |
| Escalations.Critical.Times |
integer |
否 |
Critical 級別報警重試次數。 N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
3 |
| Escalations.Critical.Threshold |
string |
否 |
Critical 級別報警閾值。 N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
90 |
| Escalations.Critical.Statistics |
string |
否 |
Critical 級別報警統計方法。 N 的取值範圍:1~50。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| Escalations.Warn.ComparisonOperator |
string |
否 |
Warn 級別閾值比較符。取值:
N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Escalations.Info.Times |
integer |
否 |
Info 級別報警重試次數。 N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
3 |
| Resources |
string |
是 |
資源資訊,例如: N 的取值範圍:1~50。 關於資源資訊支援的維度 Dimensions,請參見雲端產品監控項。 |
[{"instanceId":"i-uf6j91r34rnwawoo****"}] |
| SilenceTime |
integer |
否 |
通道沉默週期。 單位:秒,預設值:86400。 N 的取值範圍:1~50。 說明
通道沉默週期是指報警發生後未恢復正常,間隔多久重新發送一次報警通知。 |
86400 |
| Webhook |
string |
否 |
報警發生回呼時指定的 URL 位址,向 URL 發送 POST 請求。 N 的取值範圍:1~50。 |
https://alert.aliyun.com.com:8080/callback |
| ContactGroups |
string |
是 |
報警聯繫組。報警通知會發送給該報警聯繫組中的報警聯繫人。 N 的取值範圍:1~50。 說明
報警聯繫組是一組報警聯繫人,可以包含一個或多個報警聯繫人。關於如何建立報警聯繫人和報警聯繫組,請參見 PutContact 和 PutContactGroup 。 |
ECS_Group |
| Namespace |
string |
是 |
雲端產品的資料命名空間。 N 的取值範圍:1~50。 關於如何查詢雲端產品的資料命名空間,請參見雲端產品監控項。 |
acs_ecs_dashboard |
| EmailSubject |
string |
否 |
報警郵件主題。 N 的取值範圍:1~50。 |
ECS instance alert |
| Period |
string |
否 |
監控項的統計週期。 單位:秒。預設為監控項的原始上報週期。 N 的取值範圍:1~50。 說明
關於如何查詢監控項的統計週期,請參見雲端產品監控項。 |
60 |
| RuleName |
string |
是 |
報警規則名稱。 N 的取值範圍:1~50。 您可以輸入新的報警規則名稱,也可以使用雲端監控已存在的報警規則名稱。關於如何查詢報警規則名稱,請參見 DescribeMetricRuleList 。 說明
輸入新的報警規則名稱,表示建立一條閾值報警規則。 |
test123 |
| Escalations.Info.Statistics |
string |
否 |
Info 級別報警統計方法。 N 的取值範圍:1~50。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| Escalations.Warn.Times |
integer |
否 |
Warn 級別報警重試次數。 N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
3 |
| Escalations.Info.ComparisonOperator |
string |
否 |
Info 級別閾值比較符。取值:
N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Interval |
string |
否 |
報警規則的觸發週期。 單位:秒。 N 的取值範圍:1~50。 說明
關於如何查詢監控項的統計週期,請參見雲端產品監控項。 |
60 |
| Escalations.Critical.ComparisonOperator |
string |
否 |
Critical 級別閾值比較符。取值:
N 的取值範圍:1~50。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
GreaterThanOrEqualToThreshold |
| Escalations.Warn.Statistics |
string |
否 |
Warn 級別報警統計方法。 N 的取值範圍:1~50。 該參數的取值由指定雲端產品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(資訊)至少設置一個,且該報警級別中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。 |
Average |
| NoDataPolicy |
string |
否 |
無監控資料時報警的處理方式。取值:
N 的取值範圍:1~50。 |
KEEP_LAST_STATE |
| Labels |
array<object> |
否 |
當監控項達到報警條件並進行報警時,標籤同時寫入監控項,在報警通知中進行展示。 |
|
|
object |
否 |
無。 |
||
| Key |
string |
否 |
標籤鍵。 |
tagKey1 |
| Value |
string |
否 |
標籤值。 說明
標籤值支援範本參數,將範本參數替換為實際標籤值。 |
ECS |
| SendOK |
boolean |
否 |
是否發送恢復通知。 |
true |
關於公共請求參數的詳情,請參見公共參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
無。 |
||
| Code |
string |
狀態碼。 說明
200 表示成功。 |
200 |
| Message |
string |
錯誤資訊。 |
The request processing has failed due to some unknown error. |
| RequestId |
string |
請求 ID。 |
15D1440E-BF24-5A41-93E4-36864635179E |
| Success |
boolean |
操作是否成功。取值:
|
true |
| FailedListResult |
object |
||
| Target |
array<object> |
為資源設置報警規則的失敗結果列表。 |
|
|
array<object> |
無。 |
||
| RuleId |
string |
報警規則 ID。 |
a151cd6023eacee2f0978e03863cc1697c89508**** |
| Result |
object |
失敗結果。 |
|
| Code |
string |
狀態碼。 |
404 |
| Message |
string |
錯誤資訊。 |
The request processing has failed due to some unknown error. |
| Success |
boolean |
操作是否成功。取值:
|
false |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "The request processing has failed due to some unknown error.",
"RequestId": "15D1440E-BF24-5A41-93E4-36864635179E",
"Success": true,
"FailedListResult": {
"Target": [
{
"RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
"Result": {
"Code": "404",
"Message": "The request processing has failed due to some unknown error.",
"Success": false
}
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | %s | %s | |
| 422 | %s | %s | |
| 499 | %s | %s | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 204 | %s | %s | |
| 403 | %s | %s | |
| 206 | %s | %s | |
| 404 | %s | %s | |
| 503 | %s | %s | |
| 406 | %s | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。