ListPrometheusAlertRules - 查看告警规则列表 - 应用实时监控服务ARMS

查看Prometheus告警规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListPrometheusAlertRules	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	否	告警规则名称。	Prometheus_Alert
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	是	集群 ID。	c0bad479465464e1d8c1e641b0afb****
Type	string	否	告警规则类型。	自定义
Status	integer	否	告警规则启用状态，取值： `1`：开启 `0`：关闭	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>	返回结构体。
PrometheusAlertRule	object	返回结构体。
Status	integer	告警规则启用状态，取值： `1`：开启 `0`：关闭	1
Type	string	告警规则类型。	自定义
NotifyType	string	通知类型，取值： `ALERT_MANAGER`：通过报警运维中心通知。 `DISPATCH_RULE`：指定通知策略进行通知。	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	long	通知策略 ID，当 NotifyType 指定为`DISPATCH_RULE`时显示此参数。	10282
AlertName	string	告警规则名称。	Prometheus_Alert
AlertId	long	告警规则 ID。	3888704
ClusterId	string	集群 ID。	c0bad479465464e1d8c1e641b0afb****
Labels	array<object>	告警规则的标签。
Label	object	告警规则的标签。
Name	string	标签的名称。	severity
Value	string	标签的值。	critical
Annotations	array<object>	告警规则的注释。
Annotation	object	告警规则的注释。
Name	string	注释的名称。	message
Value	string	注释的值。	${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%
Tags	array<object>	标签。
tags	object	标签。
Key	string	Tag 的主键。	key
Value	string	Tag 的值。	value
Code	long	状态码。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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-07-31	OpenAPI 返回结构发生变更	查看变更详情
2023-05-11	OpenAPI 描述信息更新、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情