設置報警規(guī)則
接口說明
本文將提供一個示例,為云服務器 ECS acs_ecs_dashboard
的實例i-uf6j91r34rnwawoo****
中的監(jiān)控項cpu_total
設置閾值報警規(guī)則。該報警規(guī)則的報警聯(lián)系組為ECS_Group
、報警規(guī)則名稱為test123
、報警規(guī)則 ID 為a151cd6023eacee2f0978e03863cc1697c89508****
、Critical 級別的統(tǒng)計方法為Average
、Critical 級別的比較符為GreaterThanOrEqualToThreshold
、Critical 級別的閾值為90
和 Critical 級別的報警重試次數(shù)為3
。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cms:PutResourceMetricRule | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RuleId | string | 是 | 報警規(guī)則 ID。 您可以輸入新的報警規(guī)則 ID,也可以使用云監(jiān)控已存在的報警規(guī)則 ID。關(guān)于如何查詢報警規(guī)則 ID,請參見 DescribeMetricRuleList 。 說明
輸入新的報警規(guī)則 ID,表示創(chuàng)建一條閾值報警規(guī)則。
| a151cd6023eacee2f0978e03863cc1697c89508**** |
RuleName | string | 是 | 報警規(guī)則名稱。 您可以輸入新的報警規(guī)則名稱,也可以使用云監(jiān)控已存在的報警規(guī)則名稱。關(guān)于如何查詢報警規(guī)則名稱,請參見 DescribeMetricRuleList 。 說明
輸入新的報警規(guī)則名稱,表示創(chuàng)建一條閾值報警規(guī)則。
| test123 |
Namespace | string | 是 | 云產(chǎn)品的數(shù)據(jù)命名空間。關(guān)于如何查詢云產(chǎn)品的數(shù)據(jù)命名空間,請參見云產(chǎn)品監(jiān)控項。 說明
當您為企業(yè)云監(jiān)控創(chuàng)建 Prometheus 報警規(guī)則時,該參數(shù)必須為 acs_prometheus 。
| acs_ecs_dashboard |
MetricName | string | 是 | 監(jiān)控項名稱。關(guān)于如何查詢監(jiān)控項名稱,請參見云產(chǎn)品監(jiān)控項。 說明
當您為企業(yè)云監(jiān)控創(chuàng)建 Prometheus 報警規(guī)則時,該參數(shù)為指標倉庫名稱。關(guān)于如何獲取指標倉庫名稱,請參見 DescribeHybridMonitorNamespaceList 。
| cpu_total |
Resources | string | 是 | 資源信息,例如: 關(guān)于資源信息支持的維度 Dimensions,請參見云產(chǎn)品監(jiān)控項。 | [{"instanceId":"i-uf6j91r34rnwawoo****"}] |
ContactGroups | string | 是 | 報警聯(lián)系組。報警通知會發(fā)送給該報警聯(lián)系組中的報警聯(lián)系人。 說明
報警聯(lián)系組是一組報警聯(lián)系人,可以包含一個或多個報警聯(lián)系人。關(guān)于如何創(chuàng)建報警聯(lián)系人和報警聯(lián)系組,請參見 PutContact 和 PutContactGroup 。
| ECS_Group |
Webhook | string | 否 | 報警發(fā)生回調(diào)時指定的 URL 地址,向 URL 發(fā)送 POST 請求。 | https://alert.aliyun.com.com:8080/callback |
EffectiveInterval | string | 否 | 報警規(guī)則的生效時間范圍。 | 00:00-23:59 |
NoEffectiveInterval | string | 否 | 報警規(guī)則的失效時間范圍。 | 00:00-06:00 |
SilenceTime | integer | 否 | 通道沉默周期。單位:秒,默認值:86400。 說明
通道沉默周期是指報警發(fā)生后未恢復正常,間隔多久重新發(fā)送一次報警通知。
| 86400 |
Period | string | 否 | 監(jiān)控項的統(tǒng)計周期。單位:秒。默認為監(jiān)控項的原始上報周期。 說明
關(guān)于如何查詢監(jiān)控項的統(tǒng)計周期,請參見云產(chǎn)品監(jiān)控項。
| 60 |
Interval | string | 否 | 報警規(guī)則的觸發(fā)周期。單位:秒。 說明
關(guān)于如何查詢監(jiān)控項的統(tǒng)計周期,請參見云產(chǎn)品監(jiān)控項。
| 60 |
EmailSubject | string | 否 | 報警郵件主題。 | ECS實例報警 |
Escalations.Critical.Statistics | string | 否 | Critical 級別報警統(tǒng)計方法。 該參數(shù)的取值由指定云產(chǎn)品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| Average |
Escalations.Critical.ComparisonOperator | string | 否 | Critical 級別閾值比較符。取值:
說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| GreaterThanOrEqualToThreshold |
Escalations.Critical.Threshold | string | 否 | Critical 級別報警閾值。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 90 |
Escalations.Critical.Times | integer | 否 | Critical 級別報警重試次數(shù)。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 3 |
Escalations.Warn.Statistics | string | 否 | Warn 級別報警統(tǒng)計方法。 該參數(shù)的取值由指定云產(chǎn)品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| Average |
Escalations.Warn.ComparisonOperator | string | 否 | Warn 級別閾值比較符。取值:
說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| GreaterThanOrEqualToThreshold |
Escalations.Warn.Threshold | string | 否 | Warn 級別報警閾值。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 90 |
Escalations.Warn.Times | integer | 否 | Warn 級別報警重試次數(shù)。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 3 |
Escalations.Info.Statistics | string | 否 | Info 級別報警統(tǒng)計方法。 該參數(shù)的取值由指定云產(chǎn)品的 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| Average |
Escalations.Info.ComparisonOperator | string | 否 | Info 級別閾值比較符。取值:
說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| GreaterThanOrEqualToThreshold |
Escalations.Info.Threshold | string | 否 | Info 級別報警閾值。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 90 |
Escalations.Info.Times | integer | 否 | Info 級別報警重試次數(shù)。 說明
報警級別 Critical(嚴重)、Warn(警告)或 Info(信息)至少設置一個,且該報警級別中的參數(shù) Statistics、ComparisonOperator、Threshold 和 Times 必須同時設置。
| 3 |
NoDataPolicy | string | 否 | 無監(jiān)控數(shù)據(jù)時報警的處理方式。取值:
| KEEP_LAST_STATE |
CompositeExpression | object | 否 | 多指標的報警條件。 說明
單指標和多指標互斥,不能同時設置。
| |
ExpressionList | array<object> | 否 | 標準創(chuàng)建的報警條件列表。 | |
object | 否 | 無。 | ||
MetricName | string | 否 | 云產(chǎn)品的監(jiān)控項名稱。 | cpu_total |
Period | long | 否 | 監(jiān)控項的聚合周期。 單位:秒。 | 60 |
Statistics | string | 否 | 監(jiān)控項的統(tǒng)計方法。取值:
說明
$ 為監(jiān)控項的統(tǒng)一前綴符號。支持的云產(chǎn)品,請參見云產(chǎn)品監(jiān)控項。
| $Maximum |
ComparisonOperator | string | 否 | 閾值比較符。取值:
| GreaterThanOrEqualToThreshold |
Threshold | string | 否 | 報警閾值。 | 90 |
ExpressionListJoin | string | 否 | 多指標報警條件之間的關(guān)系。取值:
| || |
ExpressionRaw | string | 否 | 表達式創(chuàng)建的報警條件。包括但不限于以下情況:
| $Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50) |
Level | string | 否 | 報警級別。取值:
| CRITICAL |
Times | integer | 否 | 發(fā)出報警通知需要達到報警條件的次數(shù)。 | 3 |
Labels | array<object> | 否 | 當監(jiān)控項達到報警條件并進行報警時,標簽同時寫入監(jiān)控項,在報警通知中進行展示。 說明
該功能與 Prometheus 報警中的 Label 相同。
| |
object | 否 | 無。 | ||
Key | string | 否 | 標簽鍵。 | tagKey1 |
Value | string | 否 | 標簽值。 說明
標簽值支持模板參數(shù),將模板參數(shù)替換為實際標簽值。
| ECS |
Prometheus | object | 否 | Prometheus 報警。 說明
僅當您為企業(yè)云監(jiān)控創(chuàng)建 Prometheus 報警規(guī)則,需要設置該參數(shù)。
| |
PromQL | string | 否 | PromQL 查詢語句。 說明
通過 PromQL 查詢語句獲取的數(shù)據(jù)即為報警數(shù)據(jù),請您在該語句中攜帶報警閾值。
| cpuUsage{instanceId="xxxx"}[1m]>90 |
Level | string | 否 | 報警級別。取值:
| CRITICAL |
Times | integer | 否 | 發(fā)出報警通知需要達到報警條件的次數(shù)。 | 3 |
Annotations | array<object> | 否 | Prometheus 報警時,將注釋的鍵和值進行渲染,易于您對監(jiān)控項或報警規(guī)則的理解。 說明
該功能等同于 Prometheus 的 Annotation。
| |
object | 否 | 無。 | ||
Key | string | 否 | 注釋的鍵。 | summary |
Value | string | 否 | 注釋的值。 | {{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} } |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "The request processing has failed due to some unknown error.",
"RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9436",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
204 | %s | %s | - |
429 | ResourceOverLimit | The resource has exceeded the limit. %s | 超過數(shù)量限制。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-04-01 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2022-12-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2022-08-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |