ListPrometheusAlertTemplates - 查看告警模板列表

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c0bad479465464e1d8c1e641b0afb****
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9FEA6D00-317F-45E3-9004-7FB8B0B7****
PrometheusAlertTemplatesarray<object>

返回结构体。

PrometheusAlertTemplateobject
Typestring

告警规则类型。

节点
Descriptionstring

告警消息,支持按照{{$labels.xxx}}格式来引用标签。

节点 {{ $labels.instance }} 可用内存不足10%,当前可用内存 {{ $value }}%
Expressionstring

告警表达式。

node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10
Versionstring

告警规则版本。

1.0
Durationstring

持续时间,范围在 1m~1440m,单位为分钟。

1m
AlertNamestring

告警规则名称。

节点内存可用率不足10%
Labelsarray<object>

告警规则的标签。

Labelobject
Namestring

标签的名称。

severity
Valuestring

标签的值。

warning
Annotationsarray<object>

告警规则的注释。

Annotationobject
Namestring

注释的名称。

message
Valuestring

注释的值。

节点 {{ $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 }}%"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史