调用 DescribeAlarmWebhookIntegrations 接口查询告警 Webhook 集成配置。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| WebhookID | String | 否 | 1f4a9e21**** | 告警 Webhook 集成配置 ID。 |
| WebhookName | String | 否 | 飞书告警 | 告警 Webhook 集成配置名称。 |
| WebhookType | String | 否 | Lark | 告警 Webhook 集成配置的类型。 |
| PageNumber | Integer | 否 | 1 | 分页查询时的页码。默认为 1，即从第一页数据开始返回。 |
| PageSize | Integer | 否 | 20 | 分页大小。默认为 20，最大为 100。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Total | Integer | 10 | Webhook 集成配置数量。 |
| WebhookIntegrations | Array of WebhookIntegrationInfo | / | Webhook 集成配置列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| WebhookID | String | 1f4a9e21**** | Webhook 集成配置 ID。 |
| CreateTime | String | 2024-04-09 20:25:35 | Webhook 集成配置创建时间。 |
| ModifyTime | String | 2024-04-09 20:35:35 | Webhook 集成配置最近一次修改时间。 |
| WebhookUrl | String | https://open.feishu.cn/open-apis/bot/v2/hook/**** | Webhook 请求地址。 |
| WebhookName | String | 飞书告警 | Webhook 集成配置名称。 |
| WebhookType | String | Lark | Webhook 类型。 |
| WebhookMethod | String | POST | 自定义 Webhook 请求方法。 |
| WebhookSecret | String | / | Webhook 加密密钥。 |
| WebhookHeaders | Array of GeneralWebhookHeaderKV | / | 自定义 Webhook 的请求头。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| key | String | Content-Type | 自定义请求头的 Key。 |
| value | String | application/json | 自定义请求头的 Value。 |
GET https://tls-{Region}.ivolces.com/DescribeAlarmWebhookIntegrations?&WebhookID=&WebhookName=&WebhookType=&PageNumber=1&PageSize=20 HTTP/1.1
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Total": 5,
"WebhookIntegrations": [
{
"WebhookID": "0721bde9****",
"WebhookName": "yyj-wei",
"WebhookType": "wechat",
"WebhookUrl": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-04-15 10:30:55",
"ModifyTime": "2024-04-15 10:30:55"
},
{
"WebhookID": "55f51384****",
"WebhookName": "yyj-ding",
"WebhookType": "dingtalk",
"WebhookUrl": "https://oapi.dingtalk.com/robot/send?access_token=xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-04-09 20:25:35",
"ModifyTime": "2024-04-09 20:25:35"
},
{
"WebhookID": "cf667c4c****",
"WebhookName": "aaa",
"WebhookType": "custom",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": "POST",
"WebhookHeaders": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"CreateTime": "2024-03-01 18:11:02",
"ModifyTime": "2024-03-01 18:11:02"
},
{
"WebhookID": "40959044****",
"WebhookName": "alarm-001",
"WebhookType": "lark",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-02-05 11:30:31",
"ModifyTime": "2024-02-05 11:30:31"
},
{
"WebhookID": "ca2eb341-fda5****",
"WebhookName": "yyj-test",
"WebhookType": "lark",
"WebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/xxx",
"WebhookSecret": null,
"WebhookMethod": null,
"WebhookHeaders": null,
"CreateTime": "2024-02-05 11:30:09",
"ModifyTime": "2024-02-05 11:30:09"
}
]
}
您可访问公共错误码，获取更多错误码信息。