1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
查询告警接收人列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWebHookReceiver。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Filter.N | 否 | Array of Filter | 过滤条件 示例值：[{"ExactMatch": false, "Name": "Keywords", "Values": [null]}] |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | Integer | 需要返回的数量，默认为10，最大值为100 示例值：100 |
| Order | 否 | String | 排序方式 [asc:升序|desc:降序] 示例值：ASC |
| By | 否 | String | 排序字段 示例值：field |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of WebHookReceiver | 告警接收人列表 示例值：[ { "Addr": "https://testtesttesttest", "Id": 7, "Name": "123" }, { "Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=cbe03861-a7c6-48cf-a34c-443c34be0db5", "Id": 9, "Name": "勿删测试发送勿删" }, { "Addr": "https://mybot1211", "Id": 11, "Name": "bot1" }, { "Addr": "http://", "Id": 12, "Name": "12345678901234567890" }, { "Addr": "https://", "Id": 13, "Name": "123" }, { "Addr": "https://dd", "Id": 14, "Name": "123dsf..." }, { "Addr": "http://alarm", "Id": 15, "Name": "告警" }, { "Addr": "http://11", "Id": 16, "Name": "1" }, { "Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-d8a862146a73", "Id": 17, "Name": "企微" }, { "Addr": "http://qweqw阿达阿大声道", "Id": 18, "Name": "请问而让他任由他永远驱蚊器驱蚊器钱额翁企" } ] |
| TotalCount | Integer | 个数 示例值：14 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebHookReceiver
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"List": [
{
"Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=cbe03861-a7c6-48cf-a34c-44**",
"Id": 9,
"Name": "测试发送"
},
{
"Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-**",
"Id": 17,
"Name": "企微"
}
],
"RequestId": "a1fd9261-58a8-4947-877d-222198eeeb56",
"TotalCount": 2
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
