查看Prometheus警示規則列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Name |
string |
否 |
警示規則名稱。 |
Prometheus_Alert |
| RegionId |
string |
是 |
地區 ID。 |
cn-hangzhou |
| ClusterId |
string |
是 |
叢集 ID。 |
c0bad479465464e1d8c1e641b0afb**** |
| Type |
string |
否 |
警示規則類型。 |
自訂 |
| Status |
integer |
否 |
警示規則啟用狀態，取值：
|
1 |
| MatchExpressions |
string |
否 |
標籤匹配條件的 JSON 串。關於此欄位的詳細說明參見下文關於參數 MatchExpressions 的補充說明。 |
[{"key":"severity","value":"critical","operator":"re"}] |
| Tags |
array<object> |
否 |
標籤。 |
|
|
object |
否 |
標籤。 |
||
| Key |
string |
否 |
標籤的鍵(key)。 |
owner |
| Value |
string |
否 |
標籤的值（value）。 |
zhangsan |
關於參數 MatchExpressions 的補充說明
JSON 串樣本及說明
[
{
"key":"severity", // 標籤的 Key。
"value":"critical", // 標籤的 Value。
"operator":"re" // eq：等於；re：匹配正則。
}
]
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
9FEA6D00-317F-45E3-9004-7FB8B0B7**** |
| PrometheusAlertRules |
array<object> |
返回結構體。 |
|
|
array<object> |
返回結構體。 |
||
| Status |
integer |
警示規則啟用狀態，取值：
|
1 |
| Type |
string |
警示規則類型。 |
自訂 |
| NotifyType |
string |
通知類型， 取值：
|
ALERT_MANAGER |
| Expression |
string |
警示運算式。 |
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 |
string |
警示通知訊息，支援按照{{$labels.xxx}}格式來引用標籤。 |
${{$labels.pod_name}}CPU使用率大於80%，當前值{{$value}}% |
| Duration |
string |
期間，範圍在 1m~1440m，單位為分鐘。 |
1m |
| DispatchRuleId |
integer |
通知策略 ID，當 NotifyType 指定為 |
10282 |
| AlertName |
string |
警示規則名稱。 |
Prometheus_Alert |
| AlertId |
integer |
警示規則 ID。 |
3888704 |
| ClusterId |
string |
叢集 ID。 |
c0bad479465464e1d8c1e641b0afb**** |
| Labels |
array<object> |
警示規則的標籤。 |
|
|
object |
警示規則的標籤。 |
||
| Name |
string |
標籤的名稱。 |
severity |
| Value |
string |
標籤的值。 |
critical |
| Annotations |
array<object> |
警示規則的注釋。 |
|
|
object |
警示規則的注釋。 |
||
| Name |
string |
注釋的名稱。 |
message |
| Value |
string |
注釋的值。 |
${{$labels.pod_name}}CPU使用率大於80%，當前值{{$value}}% |
| Tags |
array<object> |
標籤。 |
|
|
object |
標籤。 |
||
| Key |
string |
Tag 的主鍵。 |
key |
| Value |
string |
Tag 的值。 |
value |
| Code |
integer |
狀態代碼。200 為成功，其他狀態代碼為異常。 |
200 |
| Message |
string |
返回結果的提示資訊。 |
success |
| Success |
boolean |
調用是否成功。 |
True |
樣本
正常返回樣本
JSON格式
{
"RequestId": "9FEA6D00-317F-45E3-9004-7FB8B0B7****",
"PrometheusAlertRules": [
{
"Status": 1,
"Type": "自訂",
"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": "1m",
"DispatchRuleId": 10282,
"AlertName": "Prometheus_Alert",
"AlertId": 3888704,
"ClusterId": "c0bad479465464e1d8c1e641b0afb****",
"Labels": [
{
"Name": "severity",
"Value": "critical"
}
],
"Annotations": [
{
"Name": "message",
"Value": "${{$labels.pod_name}}CPU使用率大於80%，當前值{{$value}}%"
}
],
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"Code": 200,
"Message": "success",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。