CreateNotifyTemplate--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateNotifyTemplate

最近更新时间：2024.09.03 15:42:18首次发布时间：2024.08.16 17:03:02

创建告警通知模版。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CreateNotifyTemplate&Version=2021-03-03

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateNotifyTemplate	接口名称。当前 API 的名称为 `CreateNotifyTemplate`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Name	String	是	template-demo	告警通知模版名称。相同地域内名称唯一。
Description	String	否	这是一段描述	告警通知模板的描述信息。
Channel	String	是	LarkBotWebhook	告警通知模版的渠道，取值： LarkBotWebhook：飞书告警通知模版。 DingTalkBotWebhook：钉钉告警通知模版。 WeComBotWebhook：企业微信告警通知模版。
Active	Object of NotifyIntervalTemplate	是	-	告警通知模版。
Resolved	Object of NotifyIntervalTemplate	是	-	告警恢复通知模版。

NotifyIntervalTemplate

参数	类型	是否必选	示例值	描述
Title	String	是	火山 {{ .Region }} 正在发生告警	模版的标题。
Content	String	是	告警规则: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }}) 告警级别: {{ .Level }} 告警条件: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ 持续 {{ .For }} ]	模版的内容。更多配置方式，请参见飞书消息通知模板和变量结构和参数。

请求示例

POST https://open.volcengineapi.com/?Action=CreateNotifyTemplate&Version=2021-03-03
Content-Type: application/json
{
    "Name": "template-demo",
    "Description": "这是一段描述",
    "Channel": "LarkBotWebhook",
    "Active": {
        "Title": "火山 {{ .Region }} 正在发生告警",
        "Content": "**告警规则**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**告警级别**: {{ .Level }}\n**告警条件**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ 持续 {{ .For }} ]"
    },
    "Resolved": {
        "Title": "火山 {{ .Region }} 告警恢复",
        "Content": "**告警规则**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**告警级别**: {{ .Level }}\n**告警条件**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ 持续 {{ .For }} ]"
    }
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警通知模板 ID。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateNotifyTemplate",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

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

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 the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。