1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
添加阻断白名单列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBanWhiteList。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Rules | 是 | BanWhiteList | 阻断规则 示例值:{} |
EventId | 否 | Integer | 事件ID,事件列表加白名单时传递,白名单添加成功后,会将事件变成已加白状态 示例值:653 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
IsGlobal | Boolean | 是否全局规则 示例值:1 |
IsDuplicate | Boolean | 添加规则是否重复 示例值:false |
DuplicateHosts | Array of DuplicateHosts | 重复机器的信息 示例值:{} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加阻断白名单列表
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBanWhiteList
<公共请求参数>
{
"Rules": {
"Remark": "备注",
"Uuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"IsGlobal": true,
"Id": "1",
"ModifyTime": "2020-09-22 00:00:00",
"SrcIp": "1.1.1.1",
"CreateTime": "2020-09-22 00:00:00",
"Quuids": [
"05f0bcab-726c-4ea4-8109-bcd03d5598f7"
]
}
}
输出示例
{
"Response": {
"IsDuplicate": true,
"IsGlobal": false,
"DuplicateHosts": [
{
"Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"Uuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"Id": 1
}
],
"RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.IllegalRequest | 非法请求。 |
InvalidParameter.InvalidFormat | 参数格式错误。 |
InvalidParameter.IpNoValid | IP格式不合法。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |