ListPrometheusAlertTemplates - 查看告警模板列表 - 可观测监控 Prometheus 版

调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	否	集群 ID。	c0bad479465464e1d8c1e641b0afb****
RegionId	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	9FEA6D00-317F-45E3-9004-7FB8B0B7****
PrometheusAlertTemplates	array<object>	返回结构体。
PrometheusAlertTemplate	object
Type	string	告警规则类型。	节点
Description	string	告警消息，支持按照{{$labels.xxx}}格式来引用标签。	节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%
Expression	string	告警表达式。	node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10
Version	string	告警规则版本。	1.0
Duration	string	持续时间，范围在 1m~1440m，单位为分钟。	1m
AlertName	string	告警规则名称。	节点内存可用率不足10%
Labels	array<object>	告警规则的标签。
Label	object
Name	string	标签的名称。	severity
Value	string	标签的值。	warning
Annotations	array<object>	告警规则的注释。
Annotation	object
Name	string	注释的名称。	message
Value	string	注释的值。	节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%

示例

正常返回示例

JSON格式

{
  "RequestId": "9FEA6D00-317F-45E3-9004-7FB8B0B7****",
  "PrometheusAlertTemplates": [
    {
      "Type": "节点",
      "Description": "节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%",
      "Expression": "node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10",
      "Version": "1.0",
      "Duration": "1m",
      "AlertName": "节点内存可用率不足10%",
      "Labels": [
        {
          "Name": "severity",
          "Value": "warning"
        }
      ],
      "Annotations": [
        {
          "Name": "message",
          "Value": "节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史