创建告警规则。
接口说明
说明
建议使用 CreateOrUpdateAlertRule 接口创建 Prometheus 告警规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:CreatePrometheusAlertRule | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| AlertName | string | 是 | 告警规则名称。 | Prometheus_Alert |
| ClusterId | string | 是 | 集群 ID。 | c0bad479465464e1d8c1e641b0afb**** |
| Type | string | 否 | 告警规则类型。
| 101 |
| 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，单位为分钟。 | 10m |
| 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"}] |
| Tags | array<object> | 否 | 标签。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 标签的键（key）。 | type |
| Value | string | 否 | 标签的值(value)。 | value1 |
返回参数
示例
正常返回示例
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": "10m",
"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,
"Success": true,
"Message": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-11 | OpenAPI 描述信息更新、OpenAPI 入参发生变更 | 查看变更详情 |