CreateWebhook--云监控-火山引擎

文档中心

立即注册

导航

CreateWebhook

最近更新时间：2025.05.15 11:55:15首次发布时间：2024.06.26 12:08:55

创建告警回调。

请求说明

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateWebhook	接口名称。当前 API 的名称为 `CreateWebhook`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
Name	String	是	webhook-demo	Webhook 名称。长度限制不超过 512 字节。名称可以重复。
Type	String	是	wecom	Webhook 类型，取值： custom：自定义 Webhook wecom：微信 Webhook lark：飞书 Webhook dingtalk：钉钉 Webhook
Url	String	是	https://qyapi.weixin.qq.com/xxxx	Webhook 地址。注意请填写可以通过公网访问的地址，且长度不超过 1000 个字节。

请求示例

POST https://open.volcengineapi.com?Action=CreateWebhook&Version=2018-01-01
Content-Type: application/json
{
    "Name": "webhook-demo",
    "Type": "wecom",
    "Url": "https://qyapi.weixin.qq.com/xxxx"
}

返回参数

参数	类型	示例值	描述
Data	Array of String	["155255269369******"]	Webhook ID。

返回示例

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

错误码

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