1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
分页查询当前租户下的通知策略列表,对应「通知中心 - 机器人通知 - 通知策略配置」Tab 的表格。返回的字段为「行展示」所需的精简信息。完整配置在编辑场景下使用 DescribeWebhookPolicy。每租户最多 100 个通知策略
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeWebhookPolicyList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Offset | 否 | Integer | 分页偏移量 示例值:0 |
| Limit | 否 | Integer | 每页返回数量 示例值:1 |
| Filters.N | 否 | Array of Filters | 过滤条件 |
| Order | 否 | String | 排序字段 示例值:UpdateTime |
| By | 否 | String | 排序方式 示例值:desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of WebhookPolicy | 策略列表 |
| TotalCount | Integer | 总数量 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebhookPolicyList
<公共请求参数>
{
"Offset": 0,
"Limit": 1,
"Order": "UpdateTime",
"By": "desc"
}
输出示例
{
"Response": {
"Data": [
{
"AssetScope": {
"AssetRange": 1,
"CloudTags": [],
"ExcludedInstanceIds": [],
"InstanceIds": [],
"TagIds": []
},
"CustomFields": [],
"ID": 5,
"MemberId": [],
"MsgLanguage": "zh",
"Name": "policy1",
"NotifyItems": [
{
"Levels": [
"HIGH"
],
"Module": "Alert",
"SubModule": "MALWARE_FILE"
}
],
"ReceiveFormat": "TEXT",
"ReceiverIDList": [
2
],
"ReceiverList": [],
"Status": "ON"
}
],
"TotalCount": 1,
"RequestId": "6a04ff0f-affe-4ae6-afe6-9c2f747715ba"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。