创建告警规则组。

请求说明

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

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateAlertingRuleGroup	接口名称。当前 API 的名称为 CreateAlertingRuleGroup。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
Name	String	是	test	告警规则组名称。字符串形式，取值范围为 1～64 字符。不能以数字、中划线-、下划线_或其他特殊字符开头。只能包含大小写字母、中文、数字、中划线-或下划线_。
Description	String	否	-	告警规则组描述信息。字符串形式，取值不能超过 4096 个字符。
Tags	Array of Tag	否	-	告警规则组资源标签。
AlertingRuleTemplateId	String	是	421d-**-ba4d*	告警规则模板 ID。可以使用 ListAlertingRuleTemplates 接口，获取告警规则模版 ID。
AlertingRuleTemplateVersion	String	否	1.0.1	告警规则模版的版本，不填写时表示最新版本。
WorkspaceId	String	是	421d-**-ba4d*	工作区 ID。可以使用 ListWorkspaces 接口，获取工作区 ID。
Items	Array of AlertingRuleGroupItemValue	否	-	关联的告警规则列表。
NotifyPolicyId	String	否	421dce0a-784e-4091-ba4d***	告警通知策略 ID。
NotifyGroupPolicyId	String	是	421dce0a-784e-4091-ba4d***	告警聚合策略 ID。
Variables	Array of VariableValue	否	-	变量配置。
AlertingRuleTags	Array of Tag	否	-	告警规则标签。
AlertingRuleProjectName	String	否	default	项目名称。
NotifyGroupPolicySource	String	否	VMP	告警聚合策略来源。
NotifyPolicySource	String	否	VMP	告警通知策略来源。

Tag

AlertingRuleGroupItemValue

VariableValue

参数	类型	是否必选	示例值	描述
Id	Long	否	1	变量 ID。可以使用 ListAlertingRuleTemplates 接口获取告警模版中的变量 ID。
Name	String	否	Cluster	Variable 名称。与 AlertingRuleTemplate.Variables 中的 Name 对应；升级或变量重排时可替代 ID 用于稳定匹配。
Values	Array of String	否	demo	变量的默认值，当配置为空时：若ListAlertingRuleTemplates接口中IncludeAll参数为False时，表示不选。若ListAlertingRuleTemplates接口中IncludeAll参数为True时，表示全选。

TemplateKV

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	告警规则阈值。

请求示例

返回参数

参数	类型	示例值	描述
Id	String	e28a-**-abf4*	告警规则组 ID。

返回示例

错误码

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

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.	缺少必要的参数。