1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
批量编辑自定义规则接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyBatchCustomRule。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-chengdu, ap-guangzhou, ap-seoul, ap-singapore 。 |
| Id | 是 | Integer | 批量规则Id 示例值：1110111 |
| Name | 是 | String | 规则名称 示例值：测试一下 |
| ExpireTime | 是 | Integer | 如果没有设置JobDateTime字段则用此字段，0表示永久生效，其它表示定时生效的截止时间（单位为秒） 示例值：1696867200 |
| SortId | 是 | Integer | 优先级 示例值：1 |
| ActionType | 是 | Integer | 动作类型，1代表阻断，2代表人机识别，3代表观察，4代表重定向，5代表JS校验 示例值：2 |
| Redirect | 是 | String | 重定向地址 示例值：/redirect |
| Remark | 是 | String | 备注 示例值：备注一下 |
| EventId | 是 | String | 事件Id 示例值：110222 |
| Strategies.N | 是 | Array of Strategy | 策略详情列表 |
| Domains.N | 否 | Array of String | 域名列表 示例值：["config.qcloudwaf.com","test.zjw.com"] |
| JobType | 否 | String | 规则执行的方式，TimedJob为定时执行，CronJob为周期执行 示例值：TimedJob |
| JobDateTime | 否 | JobDateTime | 定时任务配置 |
| GroupIds.N | 否 | Array of Integer | 防护对象组ID列表 示例值：[11101,11102] |
| LogicalOp | 否 | String | 匹配条件的逻辑关系，支持and、or，分别表示多个逻辑匹配条件是与、或的关系 示例值：and |
| PageId | 否 | String | 页面ID 示例值："0" |
| ActionRatio | 否 | Integer | 动作灰度的比例，1-100，默认是100 示例值：2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Res | String | 操作成功 示例值：success |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量编辑自定义规则接口
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBatchCustomRule
<公共请求参数>
{
"Id": 1101,
"Name": "",
"ExpireTime": 0,
"SortId": 0,
"ActionType": 0,
"Redirect": "/redirect",
"Bypass": "cc",
"Remark": "remark",
"EventId": "11101",
"Domains": [
"www.test.com"
],
"Strategies": [
{
"Field": "URL",
"Arg": "",
"CompareFunc": "eq",
"Content": "/acl"
}
]
}输出示例
{
"Response": {
"Res": "success",
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DomainNameVerificationError | 域名校验有误 |
| FailedOperation.TheBatchProtectionRuleNameAlreadyExists | 该批量防护规则名称已存在 |
| FailedOperation.TheFollowingDomainsHaveExceededTheUpperLimit | 以下域名已超过规格上限值 |
| FailedOperation.TheFollowingDomainsHaveInvalidTheUpperLimit | 以下域名有无效规格上限值 |
| FailedOperation.TheNameOfTheBatchProtectionRuleCannotBeEmpty | 批量防护规则名称不能为空 |
| InternalError.DBErr | DBErr |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.CELSyntaxErr | 自定义规则CEL逻辑表达式语法错误 |
| UnsupportedOperation | 操作不支持。 |
