1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
开启或禁用访问控制（自定义策略）
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyCustomRuleStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
| Domain | 是 | String | 域名 示例值：baidu.com |
| RuleId | 是 | Integer | 规则ID 示例值：1 |
| Status | 是 | Integer | 开关的状态，1是开启、0是关闭 示例值：0 |
| Edition | 否 | String | WAF的版本，clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF，默认是sparta-waf。 示例值：sparta-waf |
| DomainRuleIdList.N | 否 | Array of DomainRuleId | 规则id 示例值：[{"Domain":"www.test.com","RuleId ":0101111}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Success | ResponseCode | 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 示例值：{"Code":"Success","Message":"Success"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 切换自定义规则的开关
切换自定义规则的开关
输入示例
https://waf.tencentcloudapi.com/?Action=ModifyCustomRuleStatus
&Domain="test.qlcoud.com"
&RuleId=1101
&Status=0
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "1c30f037-a684-4d5b-b0a8-0bc0acc668d1",
"Success": {
"Message": "Success",
"Code": "Success"
}
}
}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 | 内部错误。 |
| InternalError.DBErr | DBErr |
| UnsupportedOperation | 操作不支持。 |
