ApplyObjectGroupsByAlertTemplate--云监控-火山引擎

文档中心

立即注册

导航

ApplyObjectGroupsByAlertTemplate

最近更新时间：2025.06.19 14:19:57首次发布时间：2025.06.19 14:19:57

绑定对象分组和通知策略至告警模版。

请求说明

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ApplyObjectGroupsByAlertTemplate	接口名称。当前 API 的名称为 `ApplyObjectGroupsByAlertTemplate`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
AlertTemplateId	String	是	1354766247190******	告警模版 ID。
ApplyObjects	Array of AlertNotification	是	-	绑定的对象分组。
ProjectName	String	是	default	生成告警策略所属项目。

AlertNotification

参数	类型	是否必选	示例值	描述
NotificationId	String	否	189898***00	通知策略 ID。可以调用 ListNotifications 接口，获取通知策略 ID。注意该参数的优先级比`AlertMethods`更高，因此，当使用该参数指定告警通知策略 ID 时，其他告警通知的配置（`AlertMethods`、`ContactGroupIds`、`WebhookIds`，`EffectStartAt`、`EffectEndAt`等）将失效。
AlertMethods	Array of String	否	Phone	告警通知方式，取值： Email：使用邮箱接收告警通知。 Phone：使用电话接收告警通知。 SMS：使用短信接收告警通知。 Webhook：使用 Webhook 接收告警通知。
Webhook	String	否	https://qyapi.weixin.qq.com/xxxx	当`AlertMethods`配置为`Webhook`时，指定告警回调 Webhook 地址。
WebhookIds	Array of String	否	["18913208***4528"]	当`AlertMethods`配置为`Webhook`时，指定告警 Webhook 回调 ID。可以调用 ListWebhooks 接口，获取 Webhook 回调 ID。注意 `WebhookIds`和`Webhook`参数仅能配置一个，不能同时配置。
ContactGroupIds	Array of String	否	145080093687100****	当`AlertMethods`配置为`Email`、`Phone`或`SMS`时，指定告警联系组 ID。可以调用 ListContactGroups 接口，获取联系组 ID。
ObjectGroupId	String	是	1764547228734******	对象分组 ID。
EffectStartAt	String	是	00:00	告警策略生效的开始时间，格式为`HH:MM`，例如：00:00。
EffectEndAt	String	是	23:59	告警策略生效的截止时间，格式为`HH:MM`，例如：23:59。说明 `EffectEndAt`时间必须晚于`EffectStartAt`时间。

请求示例

POST https://open.volcengineapi.com?Action=ApplyObjectGroupsByAlertTemplate&Version=2018-01-01
Content-Type: application/json
{
    "AlertTemplateId": "1354766247190******",
    "ApplyObjects": [
        {
            "ObjectGroupId": "1764547228734******",
            "Webhook": "https://qyapi.weixin.qq.com/xxxx",
            "WebhookIds": [
                "18913208***4528"
            ],
            "AlertMethods": [
                "Phone"
            ],
            "ContactGroupIds": [
                "145080093687100****"
            ],
            "EffectStartAt": "00:00",
            "EffectEndAt": "23:59"
        }
    ],
    "ProjectName": "default"
}

返回参数

参数	类型	示例值	描述
Data	Array of String	["1354766247190******"]	生成的告警策略 ID。

返回示例

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

错误码

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