ModifyAlarmWebhookIntegration--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

ModifyAlarmWebhookIntegration

最近更新时间：2024.08.02 11:18:48首次发布时间：2024.08.02 11:18:48

调用 ModifyAlarmWebhookIntegration 接口修改告警 Webhook 集成配置。

注意事项

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

请求方式：PUT
请求地址：https://tls-{Region}.ivolces.com/ModifyAlarmWebhookIntegration

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
WebhookHeaders	Array of GeneralWebhookHeaderKV	否	`/`	自定义 Webhook 的请求头，设置 WebhookType 为 GeneralWebhook 时，必填。
WebhookID	String	是	`1f4a9e21****`	Webhook 集成配置 ID。
WebhookMethod	String	否	`POST`	自定义 Webhook 请求方法，仅支持 POST、PUT。
WebhookName	String	是	`test-alarm-integration`	Webhook 集成配置名称。命名规则请参考资源命名规则。
WebhookSecret	String	否	`/`	Webhook 加密密钥。设置 WebhookType 为 Lark，且在飞书机器人中设置安全设置为签名校验时，需在此处输入飞书机器人的签名密钥。详细说明请参考自定义机器人使用指南。设置 WebhookType 为 DingTalk，且在钉钉机器人中设置了签名值时，需在此处输入钉钉机器人的签名值。详细说明请参考开发机器人。
WebhookType	String	是	`Lark`	Webhook 类型。 GeneralWebhook：自定义 Webhook 地址。 Lark：飞书。 DingTalk：钉钉。 WeChat：企业微信。
WebhookUrl	String	是	`https://open.feishu.cn/open-apis/bot/v2/hook/****`	Webhook 请求地址。

GeneralWebhookHeaderKV

参数	类型	是否必选	示例值	描述
key	String	否	`Content-Type`	自定义请求头的 Key。
value	String	否	`application/json`	自定义请求头的 Value。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

PUT https://tls-{Region}.bytepluses.com/ModifyAlarmWebhookIntegration HTTP/1.1
Content-Type: application/json
{
    "WebhookID": "3b0c6c7f****",
    "WebhookName": "yyj-test-lin",
    "WebhookType": "dingtalk",
    "WebhookUrl": "http://baidu.com",
    "WebhookSecret": "111"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

错误码

您可访问公共错误码，获取更多错误码信息。