更新告警规则组。 ## 请求说明托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://www.volcengine.com/docs/6731/1581726) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://vmp.cn\-beijing.volcengineapi.com?Action=UpdateAlertingRuleGroup&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=UpdateAlertingRuleGroup&serviceCode=vmp&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |UpdateAlertingRuleGroup |接口名称。当前 API 的名称为 `UpdateAlertingRuleGroup`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Id |String |是 |421d\-\*\*\*\*\-6037\*\*\*\* |告警规则组 ID。 | |AlertingRuleTemplateVersion |String |否 |1.0.1 |告警规则模版的版本，不填写时表示最新版本。 | |Name |String |否 |test |告警规则组名称。

* 字符串形式，取值范围为 1～64 字符。

* 不能以数字、中划线`-`、下划线`_`或其他特殊字符开头。

* 只能包含大小写字母、中文、数字、中划线`-`或下划线`_`。 | |Description |String |否 |\- |告警规则组描述信息。

字符串形式，取值不能超过 4096 个字符。 | |WorkspaceId |String |否 |421d\-\*\*\*\*\-ba4d\*\*\* |工作区 ID。

可以使用 [ListWorkspaces](https://www.volcengine.com/docs/6731/1037505) 接口，获取工作区 ID。 | |Items |Array of [AlertingRuleGroupItemValue](https://docs.volcengine.com/docs/6731/2715629#alertingrulegroupitemvalue) |否 |\- |关联的告警规则列表。 | |NotifyPolicyId |String |否 |421d\-\*\*\*\*\-ba4d\*\*\* |告警通知策略 ID。 | |NotifyGroupPolicyId |String |否 |421d\-\*\*\*\*\-ba4d\*\*\* |告警聚合策略 ID。 | |Variables |Array of [VariableValue](https://docs.volcengine.com/docs/6731/2715629#variablevalue) |否 |\- |变量配置。 | |NotifyGroupPolicySource |String |否 |VMP |告警聚合策略来源 | |NotifyPolicySource |String |否 |VMP |告警通知策略来源 | ### AlertingRuleGroupItemValue |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Id |Long |是 |1 |告警规则模板项序号。 | |Enable |Boolean |是 |true |告警规则启用状态，取值：

* **true**：启用

* **false**：禁用 | |Labels |Array of [TemplateKV](https://docs.volcengine.com/docs/6731/2715629#templatekv) |否 |\- |告警通知中的标签。 | |Levels |Array of [AlertingRuleLevel](https://docs.volcengine.com/docs/6731/2715629#alertingrulelevel) |否 |\- |告警等级。 | |Annotations |Array of [TemplateKV](https://docs.volcengine.com/docs/6731/2715629#templatekv) |否 |\- |告警通知中的注释。 | ### VariableValue |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Id |Long |否 |1 |变量 ID。

可以使用 [ListAlertingRuleTemplates](https://docs.volcengine.com/docs/vmp/list-alerting-rule-templates) 接口获取告警模版中的变量 ID。 | |Name |String |否 |Cluster |Variable 名称。与 AlertingRuleTemplate.Variables 中的 Name 对应；升级或变量重排时可替代 ID 用于稳定匹配。 | |Values |Array of String |否 |demo |变量的默认值，当配置为空时：

* 若`ListAlertingRuleTemplates`接口中`IncludeAll`参数为`False`时，表示不选。

* 若`ListAlertingRuleTemplates`接口中`IncludeAll`参数为`True`时，表示全选。 | ### TemplateKV |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Name |String |是 |key1 |标签的 Key。 | |Value |String |否 |value1 |标签的 Value，配置为空时表示将该键删除。 | ### 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 |告警规则阈值。 | ## 请求示例 ```JSON POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateAlertingRuleGroup&Version=2021-03-03 Content-Type: application/json { "Id": "421d-****-6037****", "AlertingRuleTemplateVersion": "1.0.1", "Name": "test", "Description": "-", "WorkspaceId": "421d-****-ba4d***", "Items": [ { "Id": 1, "Enable": true, "Labels": [ { "Name": "key1", "Value": "value1" } ], "Levels": [ { "For": "5m", "Level": "P0", "Threshold": 1, "Comparator": "\\>" } ], "Annotations": [ { "Name": "key1", "Value": "value1" } ] } ], "NotifyPolicyId": "421d-****-ba4d***", "NotifyGroupPolicyId": "421d-****-ba4d***", "Variables": [ { "Id": 1, "Name": "Cluster", "Values": [ "" ] } ], "NotifyGroupPolicySource": "VMP", "NotifyPolicySource": "VMP" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |e28b\-\*\*\*\*\-8808 |告警规则组 ID。 | ## 返回示例 ```JSON HTTP/1.1: 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateAlertingRuleGroup", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Id": "e28b-****-8808" } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6731/942210)。 |**HTTP 状态码** |**错误码** |**错误信息** |**说明** | |---|---|---|---| |403 |ProductUnsubscribed |You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service |当前账号未订阅 VMP 服务。 | |400 |InvalidParameter.{{parameter}} |The specified parameter {{parameter}} is invalid. |输入不合法，如工作区名称不合法等。 | |400 |MissingParameter.{{parameter}} |The required parameter {{parameter}} is missing. |缺少必要的参数。 |