調用UpdatePrometheusAlertRule接口更新Prometheus報警規則。
接口說明
UpdatePrometheusAlertRule 接口已不再維護，請使用 CreateOrUpdateAlertRule 接口創建或修改告警規則。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| AlertName | string | 是 | 告警規則名稱。 | Prometheus_Alert |
| ClusterId | string | 是 | 集群 ID。 | c0bad479465464e1d8c1e641b0afb**** |
| Type | string | 否 | 自定義告警規則類型。 | Kubernetes組件告警 |
| NotifyType | string | 否 | 通知類型， 取值：
| ALERT_MANAGER |
| DispatchRuleId | long | 否 | 通知策略 ID，當 NotifyType 指定為 | 10282 |
| Expression | string | 是 | 告警表達式，需要使用 PromQL 語句。 | 100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \"pod_name\", \"$1\", \"pod\", \"(.*)\")) by (pod_name))>75 |
| Duration | string | 是 | 持續時間，范圍在 1m~1440m，單位為分鐘。 | 1 |
| Message | string | 是 | 告警消息，支持按照{{$labels.xxx}}格式來引用標簽。 | ${{$labels.pod_name}}CPU使用率大于80%，當前值{{$value}}% |
| Labels | string | 否 | 標簽 JSON 串。需要設置標簽的 Name 和 Value。 | [{"Value": "critical","Name": "severity"}] |
| Annotations | string | 否 | 注釋 JSON 串。需要設置注釋的 Name 和 Value。 | [{"Value": "xxx","Name": "description"}] |
| AlertId | long | 是 | 告警規則 ID，您可以在 ListPrometheusAlertRules API 接口的返回數據中查看。 | 3888704 |
| Tags | array<object> | 否 | 標簽。 | |
| object | 否 | 標簽。 | ||
| Key | string | 否 | 標簽的鍵(key)。 | TestKey |
| Value | string | 否 | 標簽的值（value）。 | TestValue |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "9FEA6D00-317F-45E3-9004-7FB8B0B7****",
"PrometheusAlertRule": {
"Status": 1,
"Type": "Kubernetes組件告警",
"NotifyType": "ALERT_MANAGER",
"Expression": "100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\"pod_name\\\", \\\"$1\\\", \\\"pod\\\", \\\"(.*)\\\")) by (pod_name))>75",
"Message": "${{$labels.pod_name}}CPU使用率大于80%，當前值{{$value}}%",
"Duration": "1",
"DispatchRuleId": 10282,
"AlertName": "Prometheus_Alert",
"AlertId": 3888704,
"ClusterId": "c0bad479465464e1d8c1e641b0afb****",
"Labels": [
{
"Name": "severity",
"Value": "critical"
}
],
"Annotations": [
{
"Name": "message",
"Value": "${{$labels.pod_name}}CPU使用率大于80%，當前值{{$value}}%"
}
]
},
"Code": 200,
"Message": "success",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-31 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-11 | OpenAPI 描述信息更新、OpenAPI 入參發生變更 | 查看變更詳情 |