文档

ListPrometheusAlertTemplates - 查看告警模板列表

更新时间:

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

集群ID。

c0bad479465464e1d8c1e641b0afb****
RegionIdstring

地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

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

返回结构体。

object
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
Namestring

标签的名称。

severity
Valuestring

标签的值。

warning
Annotationsarray

告警规则的注释。

object
Namestring

注释的名称。

message
Valuestring

注释的值。

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListPrometheusAlertTemplates
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

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

错误码

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

  • 本页导读 (1)
文档反馈