UpdatePrometheusAlertRule_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

UpdatePrometheusAlertRule 接口已不再维护,请使用 CreateOrUpdateAlertRule 接口创建或修改告警规则。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
RegionIdstring

地域 ID。

示例值:cn-hangzhou
AlertNamestring

告警规则名称。

示例值:Prometheus_Alert参考取值来源:
    GetAlertRules
    ListAlerts
    CreatePrometheusAlertRule
ClusterIdstring

集群 ID。

示例值:c0bad479465464e1d8c1e641b0afb****
Typestring

自定义告警规则类型。

示例值:Kubernetes组件告警
NotifyTypestring

通知类型, 取值:展开详情

示例值:ALERT_MANAGER
DispatchRuleIdinteger<int64>

通知策略 ID,当 NotifyType 指定为DISPATCH_RULE时必填。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10282参考取值来源:
    CreateDispatchRule
    DescribePrometheusAlertRule
    ListPrometheusAlertRules
Expressionstring

告警表达式,需要使用 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
Durationstring

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

示例值:1
Messagestring

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

示例值:${{$labels.pod_name}}CPU使用率大于80%,当前值{{$value}}%
Labelsstring

标签 JSON 串。需要设置标签的 Name 和 Value。

示例值:[{"Value": "critical","Name": "severity"}]
Annotationsstring

注释 JSON 串。需要设置注释的 Name 和 Value。

示例值:[{"Value": "xxx","Name": "description"}]
AlertIdinteger<int64>

告警规则 ID,您可以在 ListPrometheusAlertRules API 接口的返回数据中查看。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3888704参考取值来源:
    ListAlerts
    UpdateAlertRule
    GetAlertRules
Tagsarray<object>

标签。

子级条数 <= 21

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:9FEA6D00-317F-45E3-9004-7FB8B0B7****
PrometheusAlertRuleobject

返回结构体。

Codeinteger<int64>

状态码。200 为成功,其他状态码为异常。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:200
Messagestring

返回信息。

示例值:success
Successboolean

操作是否成功:展开详情

示例值:True

返回示例

变更历史

变更时间变更内容概要操作
2023-07-31
变更返回参数
2023-05-11
新增请求参数Tags

相关示例