ListWebhooks--云监控-火山引擎

文档中心

立即注册

导航

ListWebhooks

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

查询告警回调详情列表。

请求说明

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWebhooks	接口名称。当前 API 的名称为 `ListWebhooks`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
Asc	Boolean	否	true	Webhook 排序方式，取值： true：升序 false：降序
EventRuleId	String	否	157284163494346****	事件规则 ID。
Name	String	否	webhook-demo	Webhook 名称，支持模糊搜索。
OrderBy	String	否	UpdatedAt	Webhook 排列依据，取值： UpdatedAt：（默认）按照 Webhook 的修改时间排列。 CreatedAt：按照 Webhook 的创建时间排列。 Name：按照 Webhook 的名称排序。
PageNumber	Integer	否	1	分页查询参数，用于设置当前页码。默认值：1。
PageSize	Integer	否	10	分页查询参数，用于设置每页行数。默认值：10。
RuleId	String	否	1354766247190******	告警策略 ID。
TotalCount	Integer	否	8	符合查询条件的 Webhook 总数。
Type	String	否	wecom	Webhook 类型，取值： custom：自定义 Webhook。 wecom：微信 Webhook。 lark：飞书 Webhook。 dingtalk：钉钉 Webhook。
Url	String	否	https://qyapi.weixin.qq.com/xxxx	Webhook 地址。

请求示例

POST https://open.volcengineapi.com?Action=ListWebhooks&Version=2018-01-01
Content-Type: application/json
{
    "Name": "webhook-demo"
}

返回参数

参数	类型	示例值	描述
Data	Array of WebhookVO	-	Webhook 详情。

WebhookVO

参数	类型	示例值	描述
Id	String	1599*****9648	Webhook ID。
Url	String	https://qyapi.weixin.qq.com/xxxx	Webhook 地址。
Name	String	Webhook-demo	Webhook 名称。
Type	String	wecom	Webhook 类型。 custom：自定义 Webhook。 wecom：微信 Webhook。 lark：飞书 Webhook。 dingtalk：钉钉 Webhook。
RuleIds	Array of String	1354766247190******	告警策略 ID。
EventRuleIds	Array of String	157284163494346****	事件规则 ID。
CreatedAt	String	2021-10-25T18:27:24+08:00	Webhook 的创建时间。
UpdatedAt	String	2021-10-25T18:49:43+08:00	Webhook 的更新时间。

返回示例

{
    "ResponseMetadata": {
        "Action": "ListWebhooks",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            {
                "Id": "1599*****9648",
                "Url": "https://qyapi.weixin.qq.com/xxxx",
                "Name": "webhook-demo",
                "Type": "wecom",
                "RuleIds": [
                    "1354766247190******"
                ],
                "EventRuleIds": [
                    "157284163494346****"
                ],
                "CreatedAt": "2021-10-25T18:27:24+08:00",
                "UpdatedAt": "2021-10-25T18:49:43+08:00"
            }
        ]
    }
}

错误码

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