1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
查询告警策略
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWebHookPolicy。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Filter.N | 否 | Array of Filter | 过滤条件 示例值：[{"Name":"Id","Values":["12657"]}] |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | Integer | 需要返回的数量，默认为10，最大值为100 示例值：100 |
| Order | 否 | String | 排序方式 [asc:升序|desc:降序] 示例值：desc |
| By | 否 | String | 排序字段 示例值：Id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of WebHookPolicy | 策略列表 示例值：[ { "CustomFields": [ { "Key": "机器a", "Value": "文本" } ], "Events": [ { "ControlBit": "11", "Type": 4 }, { "ControlBit": "11", "Type": 13 }, { "ControlBit": "1", "Type": 14 }, { "ControlBit": "", "Type": 22 }, { "ControlBit": "1", "Type": 23 }, { "ControlBit": "", "Type": 1 }, { "ControlBit": "11", "Type": 3 }, { "ControlBit": "1", "Type": 7 }, { "ControlBit": "1", "Type": 12 }, { "ControlBit": "1", "Type": 19 }, { "ControlBit": "1", "Type": 20 }, { "ControlBit": "", "Type": 25 }, { "ControlBit": "1", "Type": 8 }, { "ControlBit": "1111", "Type": 18 }, { "ControlBit": "1111", "Type": 17 }, { "ControlBit": "11111", "Type": 2 }, { "ControlBit": "111", "Type": 6 }, { "ControlBit": "1111", "Type": 9 }, { "ControlBit": "1111", "Type": 10 }, { "ControlBit": "1111", "Type": 11 }, { "ControlBit": "11", "Type": 15 }, { "ControlBit": "1111", "Type": 16 }, { "ControlBit": "1", "Type": 21 }, { "ControlBit": "1", "Type": 24 } ], "Format": 0, "HostCount": 3, "HostLabels": [ { "Type": 4, "Values": [] } ], "Id": 38, "IsDisabled": 0, "Name": "只有机器a；文本", "Quuids": [ "058e0cf8-ba52-47fc-a100-2fdcc1e73e96", "00e800cb-7202-4d83-90c2-6e920758dd42", "380add75-bb06-4cc4-84c5-cf806d102fba" ], "Receivers": [ { "Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-d8a862146a73", "Id": 17, "Name": "企微" } ] } ] |
| TotalCount | Integer | 策略列表总数 示例值：16 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebHookPolicy
<公共请求参数>
{
"Offset": 0,
"Limit": 1
}输出示例
{
"Response": {
"List": [
{
"CustomFields": [
{
"Key": "机器a",
"Value": "文本"
}
],
"Events": [
{
"ControlBit": "1010",
"Type": 18
},
{
"ControlBit": "1010",
"Type": 17
},
{
"ControlBit": "1010",
"Type": 2
},
{
"ControlBit": "1010",
"Type": 6
},
{
"ControlBit": "1010",
"Type": 9
},
{
"ControlBit": "1010",
"Type": 10
},
{
"ControlBit": "1010",
"Type": 11
},
{
"ControlBit": "1010",
"Type": 15
},
{
"ControlBit": "1010",
"Type": 16
},
{
"ControlBit": "1",
"Type": 21
},
{
"ControlBit": "1",
"Type": 24
}
],
"Format": 0,
"HostCount": 3,
"HostLabels": [
{
"Type": 4,
"Values": [
"Value1"
]
}
],
"Id": 38,
"IsDisabled": 0,
"Name": "机器人",
"Quuids": [
"058e0cf8-ba52-47fc-a100-2fdcc1e73e96",
"00e800cb-7202-4d83-90c2-6e920758dd42",
"380add75-bb06-4cc4-84c5-cf806d102fba"
],
"Receivers": [
{
"Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-d8a**",
"Id": 17,
"Name": "企微"
}
]
}
],
"RequestId": "6933d139-3143-4590-805f-712489ea91b8",
"TotalCount": 16
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
