文档中心

托管 Prometheus

告警规则

UpdateAlertingRule

更新告警规则。

请求说明

托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=UpdateAlertingRule&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

说明

Type和Query参数必须同时存在。

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateAlertingRule	接口名称。当前 API 的名称为 UpdateAlertingRule。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
Id	String	是	90b5a3da-3464-4718-92e4-039bf41d3cff	告警规则 ID。
Name	String	否	alert-rule-demo	告警规则名称。
Description	String	否	this is a alert rule demo	告警规则描述信息。
Type	String	否	vmp/PromQL	告警规则类型，固定取值为vmp/PromQL。
Query	Object of AlertingRuleQuery	否	-	告警配置。
Levels	Array of AlertingRuleLevel	否	-	告警等级。
NotifyPolicyId	String	否	e28ae750-bbb8-4ff4-abf4***	告警通知策略 ID。
NotifyGroupPolicyId	String	否	e28ae750-bbb8-4ff4-abf4***	告警聚合策略 ID。
Annotations	Array of TemplateKV	否	-	附加到告警的注释。
Labels	Array of TemplateKV	否	-	附加到告警的标签。

AlertingRuleQuery

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	e28ae750-bbb8-4ff4-abf4***	工作区 ID。
PromQL	String	是	sum(up)	查询语句。

AlertingRuleLevel

参数	类型	是否必选	示例值	描述
Level	String	是	P0	告警规则等级，当前支持 P0、P1 或 P2。
For	String	是	5m	告警持续时间，取值： 0s：立即触发 1m：1 分钟 2m：2 分钟 5m：5 分钟 10m：10 分钟
Comparator	String	是	>	告警规则比较条件，取值： >：大于 >=：大于等于 <：小于 <=：小于等于 ==：等于 !=：不等于
Threshold	Double	否	1.0	告警规则阈值。

TemplateKV

参数	类型	是否必选	示例值	描述
Name	String	是	key1	标签或注释的 Key。
Value	String	否	value1	标签或注释的 Value，配置为空时表示将该键删除。

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateAlertingRule&Version=2021-03-03​
Content-Type: application/json​
{​
    "Id": "90b5a3da-3464-4718-92e4-039bf41d3cff",​
    "Name": "alert-rule-demo",​
    "Description": "this is a alert rule demo",​
    "Type": "vmp/PromQL",​
    "Query": {​
        "PromQL": "sum(up)",​
        "WorkspaceId": "e28ae750-bbb8-4ff4-abf4***"​
    },​
    "Levels": [​
        {​
            "For": "5m",​
            "Level": "P0",​
            "Threshold": 1,​
            "Comparator": ">"​
        }​
    ],​
    "NotifyPolicyId": "e28ae750-bbb8-4ff4-abf4***",​
    "NotifyGroupPolicyId": "e28ae750-bbb8-4ff4-abf4***",​
    "Labels": [​
        {​
            "Name": "key1",​
            "Value": "value1"​
        }​
    ],​
    "Annotations": [​
        {​
            "Name": "key1",​
            "Value": "value1"​
        }​
    ]​
}

返回参数

参数	类型	示例值	描述
Id	String	90b5a3da-3464-4718-92e4***	告警规则 ID。

返回示例

HTTP/1.1: 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "UpdateAlertingRule",​
        "Version": "2021-03-03",​
        "Service": "vmp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Id": "90b5a3da-3464-4718-92e4***"​
    }​
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
404	NotFound.Id	The specified Contact/ContactGroup {{Id}} is not found.	未找到指定联系人/联系人组。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。

最近更新时间：2025.11.05 17:12:26

这个页面对您有帮助吗？

有用

无用