You need to enable JavaScript to run this app.
文档中心
日志服务

日志服务

复制全文
下载 pdf
告警管理
CreateAlarmWebhookIntegration
复制全文
下载 pdf
CreateAlarmWebhookIntegration
调用 CreateAlarmWebhookIntegration 接口创建 Webhook 集成配置。​
使用说明​
  • 此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。​
  • 日志服务告警支持如下安全配置。​
  • 飞书和钉钉渠道​
  • 自定义关键词​
  • 如果在飞书或钉钉机器人中配置了自定义关键词,则需要在日志服务的告警通知内容中至少添加其中 1 个关键词。使用此方式时,建议在钉钉或飞书侧将其中一个关键字设置为告警。​
  • 签名校验​
  • 如果在飞书或钉钉机器人中配置了加签密钥,则需要在日志服务侧的 Webhook 集成配置中输入该加签密钥。​
  • 其他自定义 Webhook 地址​
  • 通过 HTTP 请求头进行权限校验,即在请求头中添加 "Authorization": "Bearer ${token}",其中需将 ${token}替换为您自定义的 Token。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://{tls-endpoint}/CreateAlarmWebhookIntegration​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
WebhookHeaders​
否​
/​
自定义 Webhook 的请求头。​
设置 WebhookType 为 GeneralWebhook时,必填。​
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。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。​
​
参数​
类型​
示例值​
描述​
AlarmWebhookIntegrationId​
String​
1f4a9e21****​
Webhook 集成配置 ID。​
​
请求示例​
​
POST https://{tls-endpoint}/CreateAlarmWebhookIntegration HTTP/1.1​
Content-Type: application/json​
{​
"WebhookName": "yyj-test-lin",​
"WebhookType": "lark",​
"WebhookUrl": "http://baidu.com",​
"WebhookSecret": "111"​
}​
​
返回示例​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​
{​
"AlarmWebhookIntegrationId": "3b0c6c7f****"​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
最近更新时间:2025.10.14 14:28:15
这个页面对您有帮助吗?
有用
有用
无用
无用