该接口用于在指定的WAF运行阶段中批量创建规则。通过此接口,用户可以一次性创建多个规则,并为这些规则配置共享的设置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
esa:BatchCreateWafRules | create | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SiteId | long | 是 | 站点 ID,可通过调用 ListSites 接口获取。 | 1 |
SiteVersion | integer | 否 | 站点版本。 | 0 |
Phase | string | 否 | WAF 规则类型,取值:
| http_anti_scan |
RulesetId | long | 否 | 规则集 ID。 | 10000001 |
Shared | WafBatchRuleShared | 否 | 多规则共享配置,指定多个规则的共有属性。 | |
Configs | array | 否 | 各规则配置列表,指定每个规则的详细配置。 | |
WafRuleConfig | 否 | 规则配置。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"RulesetId": 10000001,
"Ids": [
20000001
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
400 | SpecifiedVersionReadOnly | The specified version number is read-only and cannot be modified. | 指定的版本号为只读版本, 无法修改版本配置。 |
403 | %s.NotSupport | The specified resource type %s is not supported. | 不支持指定的资源类型。如需使用该类型资源,请与我们联系。 |
403 | %s.OverQuota | The quantity of %s exceeds the quota. | 该资源的数量超出了配额所规定的范围,如需申请更多的额度,请与我们联系。 |
403 | %s.WrongValueMatched | The value of specified parameter %s can not pass the matching check. | 指定的参数对应的值不能通过匹配校验。如果您确定需要使用该参数值,请与我们联系。 |
403 | Rule.Config.Malformed | The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements. | 指定的规则配置格式错误或未按要求格式编写。请检查规则配置中是否存在语法错误或结构不一致,并予以纠正,以符合预期的配置架构。 |
403 | Rule.Config.Noncompliance | The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations. | 指定的规则配置未满足既定的合规性标准。请检查规则设置,查找任何不符合或违反预期标准的差异,并进行必要的调整,以确保所有规则均得到正确验证。 |
403 | Ruleset.Name.AlreadyExists | The specified rule set name already exists.Try again with a unique name or modify the existing rule set name. | 指定的规则集名称在系统的规则管理架构中已存在。请选择一个独一无二的替代名称,以避免重复和与现有规则集潜在的冲突。如果是对现有规则集进行重命名,请确保新名称是独特的,并且不侵犯其他已建立规则集的标识符。 |
403 | Site.NotExist | The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system. | 指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确,并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的,请确保已完成适当的创建或注册流程,以将其整合到系统中。 |
403 | Expression.Invalid | The specified expression is invalid: %s. | 指定的表达式是无效的。 |
403 | Ruleset.NotExist | The specified rule set does not exist or has not been registered in the system.Check whether the specified rule set identifier is valid and matches a rule set that has been correctly defined and maintained by the system's rule set registry.If you want to add a new rule set, make sure that the creation and registration process is complete to bring the rule set into effect. | 指定的规则集不存在或尚未在当前系统配置中注册。请确认规则集标识符是否正确,并且指向一个已经正确定义并在系统的规则集注册表中维护的规则集。如果该规则集是一个新实体,请确保其创建和注册的必要步骤已经成功执行,以便其可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-18 | OpenAPI 错误码发生变更 | 查看变更详情 |