You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API参考/告警回调/ListWebhooks
ListWebhooks
最近更新时间：2024.10.23 20:25:05首次发布时间：2024.06.26 12:08:55
我的收藏

查询告警回调详情列表。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=ListWebhooks&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是ListWebhooks接口名称。当前 API 的名称为 ListWebhooks。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。

Body

参数类型是否必选示例值描述

Asc

Boolean

否

true

webhook排序方式。

  • true：升序
  • false：降序
EventRuleIdString否-事件规则ID。
NameString否testwebhook名称，按照名称模糊搜索。

OrderBy

String

否

UpdatedAt

webhook排列依据。

  • UpdatedAt（默认）：按照webhook的修改时间排列
  • Name：按照webhook的名称排序
  • CreatedAt：按照webhook的创建时间排列
PageNumberInteger否1分页查询参数，用于设置当前页码。默认值：1。
PageSizeInteger否10分页查询参数，用于设置每页行数。默认值：10。
RuleIdString否-告警策略ID。
TotalCountInteger否8符合条件的webhook总数。

Type

String

否

custom

webhook的类型。

  • custom：自定义webhook
  • wecom：微信webhook
  • lark：飞书webhook
  • dingtalk：钉钉webhook
UrlString否https://xxxxwebhook的地址。

返回参数

参数类型示例值描述
DataArray of WebhookVO-返回内容。

WebhookVO

参数类型示例值描述
IdString1599*****9648webhook ID。
UrlStringhttps://xxxxwebhook的地址。
NameStringtestwebhook的名称。

Type

String

custom

webhook的类型。

  • custom：自定义webhook
  • wecom：微信webhook
  • lark：飞书webhook
  • dingtalk：钉钉webhook
RuleIdsArray of String-告警策略ID。
CreatedAtString2021-10-25T18:27:24+08:00webhook创建时间。
UpdatedAtString2021-10-25T18:49:43+08:00webhook更新时间。
EventRuleIdsArray of String-事件规则ID。

请求示例

POST https://open.volcengineapi.com?Action=ListWebhooks&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "PageSize": 10,
    "PageNumber": 1,
    "Ids": [
        "1744977683943******"
    ],
    "Name": "测试"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240624160753784B7BF50425257*****",
        "Action": "ListWebhooks",
        "Version": "2018-01-01",
        "Service": "volc_observe_boe",
        "Region": "cn-nanjing-bbit"
    },
    "Result": {
        "Data": [
            {
                "Id": "1599*****9648",
                "Name": "test",
                "CreatedAt": "2021-10-25T18:27:24+08:00",
                "UpdatedAt": "2021-10-25T18:49:43+08:00",
                "Type": "custom",
                "Url": "https://xxxx",
                "RuleIds": [
                    "***",
                    "..."
                ],
                "EventRuleIds": [
                    "***",
                    "..."
                ]
            }
        ],
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

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