UpdateAclRule - 更新访问管控规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

UpdateAclRule - 更新访问管控规则

最近更新时间：2024.11.21 18:07:05首次发布时间：2024.11.21 11:31:18

访问管控规则添加完成后，如您希望修改接口信息，可调用 UpdateAclRule 接口执行修改。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateAclRule&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateAclRule	要执行的操作，取值：UpdateAclRule。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
Action	String	否	observe	执行动作。 block：拦截 observe：观察
IpLocationCountry	Array of String	否	"US","JP"	海外国家或地区代码，`IpAddType = 4`（地理位置添加方式）时需要填写。详情可参考ISO 3166-1 Alpha-2 编码标准，例如： US：美国 BR：巴西 JP：日本
IpList	Array of String	否	"192.1.1.1","192.1.1.2"	IP 地址，`IpAddType = 3`（多地址添加模式）时需要填写，且至少填写 2 个 IP 地址。
IpGroupId	Array of Integer	否	6283,7515	地址组 ID，`IpAddType = 2`（地址组添加模式）时需要填写，可参考查询所有地址组获取 IP 地址组 ID。
IpAddType	Integer	是	4	IP 地址添加方式。默认为手动添加。 1：手动添加 2：地址组添加 3：多地址添加 4：地理位置添加
ID	Integer	是	126217	需要编辑的规则 ID，可通过查询访问管控规则获取对应 ID。
HostList	Array of String	否	"*.4399.com","www.test.com"	域名信息，`HostAddType = 3`（多域名添加模式）时需要填写，且至少填写 2 个域名。
HostGroupId	Array of Integer	否	7436,7515	域名组 ID，`HostAddType = 2`（域名组添加方式）时需要填写，可参考查询域名组获取域名组 ID。
HostAddType	Integer	是	2	域名添加方式。 2：域名组添加 3：多域名添加
Enable	Integer	是	1	是否启用规则。 0：关闭 1：开启
Description	String	否	禁止特定 IP 访问。	规则描述。
Advanced	Integer	否	1	是否设置高级条件。默认为否。 0：否 1：是
AclType	String	是	Block	访问管控规则类型。 Allow：允许访问名单 Block：禁止访问名单
IpLocationSubregion	Array of String	否	"Anhui","Guangdong"	国内地区代码，`IpAddType = 4`（地理位置添加方式）时需要填写，填写省级行政区域拼音全称。详情可参考国内地理位置列表，例如： Beijing：北京 Fujian：福建 Gansu：甘肃
Name	String	是	访问控制1	规则名称。支持英文、汉字、数字，不支持特殊字符。长度限制在 25 个字符内。
PrefixSwitch	Integer	否	0	是否开启前缀匹配。默认关闭。 0：关闭 1：开启
Url	String	是	/path	匹配路径。支持通配符``，``只能出现一次。某个具体的 URL 地址，例如需要放行`test.com/test.html`，则填写 `/test.html`。针对整个网站，则填写`/`即可。某个路径前缀适配的所有地址，例如`/test/*`。
AccurateGroup	Object	否	--	高级条件，未配置时无需设置。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Id	Integer	126217	规则 ID。

请求示例

POST /?Action=UpdateAclRule&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241121T031718Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241121/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Action": "observe",
  "IpLocationCountry": [
    "US",
    "JP"
  ],
  "IpList": [
    "192.1.1.1",
    "192.1.1.2"
  ],
  "IpGroupId": [
    6283
  ],
  "IpAddType": 4,
  "ID": 126217,
  "HostList": [
    "*.4399.com",
    "www.test.com"
  ],
  "HostGroupId": [
    7436
  ],
  "HostAddType": 2,
  "Enable": 1,
  "Description": "禁止特定 IP 访问。",
  "Advanced": 1,
  "AclType": "Block",
  "IpLocationSubregion": [
    "Anhui",
    "Guangdong"
  ],
  "Name": "访问控制1",
  "PrefixSwitch": 0,
  "Url": "/path",
  "AccurateGroup": {
    "Logic": 1,
    "AccurateRules": [
      {
        "ValueString": "Get",
        "Opretar": 2,
        "ObjType": 2,
        "HttpObj": "request.schema",
        "Property": 0
      }
    ]
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202411211803242480011642548B0267",
    "Action": "UpdateAclRule",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": 126217
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。