CreateNotifyPolicy--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateNotifyPolicy

最近更新时间：2024.09.03 15:42:18首次发布时间：2023.06.30 15:23:34

创建告警通知策略。

请求说明

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

请求参数

注意

Levels.Level 的值不能重复。

参数	类型	是否必选	示例值	描述
Action	String	是	CreateNotifyPolicy	接口名称。当前 API 的名称为 `CreateNotifyPolicy`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Name	String	是	test	告警通知策略名称。
Description	String	否	这是一段描述	告警通知策略描述信息。
Levels	Array of NotifyPolicyLevel	是	-	告警通知策略等级。

NotifyPolicyLevel

参数	类型	是否必选	示例值	描述
Level	String	是	P0	告警通知策略等级，包括：P0、P1 和 P2。
ContactGroupIds	Array of String	是	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	告警通知策略的联系人组。
Channels	Array of String	是	["Email"]	告警通知策略的告警通知方式： Email：邮件 Webhook：通用 Webhook LarkBotWebhook：飞书机器人 DingTalkBotWebhook：钉钉机器人 WeComBotWebhook：企业微信机器人

参数

类型

是否必选

示例值

描述

Level

String

是

告警通知策略等级，包括：P0、P1 和 P2。

ContactGroupIds

Array of String

是

["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]

告警通知策略的联系人组。

Channels

Array of String

是

["Email"]

告警通知策略的告警通知方式：

Email：邮件
Webhook：通用 Webhook
LarkBotWebhook：飞书机器人
DingTalkBotWebhook：钉钉机器人
WeComBotWebhook：企业微信机器人

请求示例

POST https://open.volcengineapi.com/?Action=CreateNotifyPolicy&Version=2021-03-03
Content-Type: application/json
{
    "Name": "test",
    "Description": "这是一段描述",
    "Levels": [
        {
            "Level": "P0",
            "Channels": [
                "Email"
            ],
            "ContactGroupIds": [
                "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
            ]
        }
    ]
}

返回参数

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

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateNotifyPolicy",
        "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}}.	指定的名称与已有资源重复。