CreateNotification--云监控-火山引擎

文档中心

立即注册

导航

CreateNotification

最近更新时间：2025.04.14 14:43:15首次发布时间：2025.04.14 14:43:15

创建通知策略。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateNotification&Version=2018-01-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateNotification	接口名称。当前 API 的名称为 `CreateNotification`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
Name	String	否	notification-demo	通知策略名称。取值范围为 1～128。不能以数字、中划线开头。
Notifications	Array of Notify	否	-	通知策略详情。
EffectStartAt	String	否	00:00	通知策略生效的开始时间，格式为`HH:MM`，例如：00:00。
EffectEndAt	String	否	23:59	通知策略生效的截止时间，格式为`HH:MM`，例如：23:59。说明 `EffectEndAt`时间必须晚于`EffectStartAt`时间。

Notify

参数	类型	是否必选	示例值	描述
Level	String	否	notice	告警通知等级，取值： notice：通知 warning：警告 critical：严重 recovery：恢复
WebhookIds	Array of String	否	18913208***4528	Webhook 回调 ID。可以调用 ListWebhooks 接口，获取 Webhook 回调 ID。
AlertMethods	Array of String	否	Email	告警通知方式，取值： Email：使用邮箱接收告警通知。 Phone：使用电话接收告警通知。 SMS：使用短信接收告警通知。 Webhook：使用 Webhook 接收告警通知。
ContactGroupIds	Array of String	否	145080093687100****	告警联系组 ID。可以调用 ListContactGroups 接口，获取联系组 ID。

请求示例

POST https://open.volcengineapi.com?Action=CreateNotification&Version=2018-01-01
Content-Type: application/json
{
    "Name": "notification-demo",
    "Notifications": [
        {
            "Level": "notice",
            "WebhookIds": [
                "18913208***4528"
            ],
            "AlertMethods": [
                "Email"
            ],
            "ContactGroupIds": [
                "145080093687100****"
            ]
        }
    ],
    "EffectStartAt": "00:00",
    "EffectEndAt": "23:59"
}

返回参数

参数	类型	示例值	描述
Data	Array of String	189898***00	通知策略 ID。

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateNotification",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            "189898***00"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。