创建告警模版。 ## 请求说明 * 请求方式：POST * 请求地址：https://vmp.cn\-beijing.volcengineapi.com?Action=CreateAlertingRuleTemplate&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=CreateAlertingRuleTemplate&serviceCode=vmp&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateAlertingRuleTemplate |接口名称。当前 API 的名称为 `CreateAlertingRuleTemplate`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Name |String |是 |test |告警规则模板名称。 | |Description |String |否 |\- |描述信息。 | |Tags |Array of [Tag](https://docs.volcengine.com/docs/6731/2715635#tag) |否 |\- |资源标签。 | |Items |Array of [AlertingRuleTemplateItem](https://docs.volcengine.com/docs/6731/2715635#alertingruletemplateitem) |是 |\- |告警规则列表。 | |Variables |Array of [VariableWithoutId](https://docs.volcengine.com/docs/6731/2715635#variablewithoutid) |否 |\- |变量列表。 | |Labels |Array of [TemplateKV](https://docs.volcengine.com/docs/6731/2715635#templatekv) |否 |\- |告警规则模版全局标签，可附加到告警的 alert 中，优先级比模版中单条规则配置的优先级高。 | ### Tag |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |是 |doc |标签的 Key。 | |Value |String |否 |demo |标签的 Value。 | ### AlertingRuleTemplateItem |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Id |Long |否 |1 |告警规则模板项序号。 | |Name |String |是 |test5 |告警规则模板项名称。 | |Labels |Array of [TemplateKV](https://docs.volcengine.com/docs/6731/2715635#templatekv) |否 |\- |附加到告警规则的标签。 | |Levels |Array of [AlertingRuleLevel](https://docs.volcengine.com/docs/6731/2715635#alertingrulelevel) |否 |\- |告警等级。 | |PromQL |String |是 |my_metrics{cluster=~"$Cluster"} |告警规则 PromQL。 | |Annotations |Array of [TemplateKV](https://docs.volcengine.com/docs/6731/2715635#templatekv) |否 |\- |附加到告警规则的注释。 | |Description |String |否 |\- |告警规则描述。 | ### VariableWithoutId |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Name |String |是 |Cluster |变量名，在 PromQL 中使用这个值。 | |Type |String |是 |Query |变量类型 Query\|Custom，Query 类型表示变量值需要通过查询 promQL, Custom 则通常从 Values 中取值。 | |Alias |String |否 |Cluster |变量假名，展示在变量选择器中。 | |Multi |Boolean |是 |true |是否支持多选。取值：

* **true**：支持。

* **false**：不支持。 | |Query |String |是 |kube_pod_info |变量值查询语句，仅适用于 Query 类型 Variable。 | |Regex |String |否 |/.*pod="(.* ?)".\* |提取变量值的正则表达式，仅适用于 Query 类型 Variable。 | |Values |Array of String |否 |\- |固定变量值列表，仅适用于 Custom 类型 Variable。 | |Default |Array of String |否 |\- |变量默认值。

> **说明**

> 当配置为空时：

> 若 `IncludeAll` 为 `False`，表示不选；如果 `IncludeAll`为 `True`，表示全选。
| |IncludeAll |Boolean |是 |true |是否支持 “全选” 选项。

* **true**：支持。

* **false**：不支持。 | ### 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=CreateAlertingRuleTemplate&Version=2021-03-03 Content-Type: application/json { "Name": "test", "Description": "-", "Tags": [ { "Key": "doc", "Value": "demo" } ], "Items": [ { "Id": 1, "Name": "test5", "Labels": [ { "Name": "key1", "Value": "value1" } ], "Levels": [ { "For": "5m", "Level": "P0", "Threshold": 1, "Comparator": "\\>" } ], "PromQL": "my_metrics{cluster=~\"$Cluster\"}", "Annotations": [ { "Name": "key1", "Value": "value1" } ], "Description": "-" } ], "Variables": [ { "Name": "Cluster", "Type": "Query", "Alias": "Cluster", "Multi": true, "Query": "kube_pod_info", "Regex": "/.*pod=\\\"(.*?)\\\".*", "Values": [ "" ], "Default": [ "" ], "IncludeAll": true } ], "Labels": [ { "Name": "key1", "Value": "value1" } ] } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |e28a\-\*\*\*\*\-808c\*\*\*\* |告警模版 ID。 | ## 返回示例 ```JSON HTTP/1.1: 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateAlertingRuleTemplate", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Id": "e28a-****-808c****" } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](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. |缺少必要的参数。 |

托管 Prometheus