You need to enable JavaScript to run this app.
导航
CreateAclRule - 创建访问管控规则
最近更新时间:2025.01.08 12:00:58首次发布时间:2024.10.12 14:25:50

您可以使用 CreateAclRule 接口创建访问管控规则,管控指定 IP 地址的访问。支持设置对应的允许访问名单和禁止访问名单。

请求说明

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

调试

请求参数

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

Query

参数
类型
是否必填
示例值
描述
Action
String

CreateAclRule

要执行的操作,取值:CreateAclRule。

Version
String

2023-12-25

API的版本,取值:2023-12-25。

Body

参数
类型
是否必填
示例值
描述
Action
String

observe

执行动作。

  • block:拦截
  • observe:观察
HostGroupId
Array of Integer

7436

域名组 ID,HostAddType = 2(域名组添加方式)时需要填写,可参考查询域名组获取域名组 ID。

Description
String

禁止特定 IP 访问。

规则描述。

Name
String

访问控制1

规则名称。

  • 支持英文、汉字、数字,不支持特殊字符。
  • 长度限制在 25 个字符内。
IpLocationCountry
Array of String

"US","JP"

海外国家或地区代码,IpAddType = 4(地理位置添加方式)时需要填写。详情可参考ISO 3166-1 Alpha-2 编码标准,例如:

  • US:美国
  • BR:巴西
  • JP:日本
IpLocationSubregion
Array of String

"Anhui","Guangdong"

国内地区代码,IpAddType = 4(地理位置添加方式)时需要填写,填写省级行政区域拼音全称。详情可参考国内地理位置列表,例如:

  • Beijing:北京
  • Fujian:福建
  • Gansu:甘肃
AccurateGroup
Object

--

高级条件,未配置时无需设置。

Url
String

/path

匹配路径。支持通配符**只能出现一次。

  • 某个具体的 URL 地址,例如需要放行test.com/test.html,则填写 /test.html
  • 针对整个网站,则填写/*即可。
  • 某个路径前缀适配的所有地址,例如/test/*
PrefixSwitch
Integer

0

是否开启前缀匹配。默认关闭。

  • 0:关闭
  • 1:开启
IpAddType
Integer

4

IP 地址添加方式。

  • 1:手动添加
  • 2:地址组添加
  • 3:多地址添加
  • 4:地理位置添加
HostAddType
Integer

2

域名添加方式。

  • 2:域名组添加
  • 3:多域名添加
Enable
Integer

1

是否启用规则。

  • 0:关闭
  • 1:开启
Advanced
Integer

1

是否设置高级条件。默认为否。

  • 0:否
  • 1:是
AclType
String

Block

访问管控规则类型。

  • Allow:允许访问名单
  • Block:禁止访问名单
HostList
Array of String

"*.test.com","www.test.com"

HostAddType = 3(多域名添加模式)时需要填写,支持单个或多个域名。

IpGroupId
Array of Integer

6283

IpAddType = 2(地址组添加模式)时需要填写,可参考查询所有地址组获取 IP 地址组 ID。

IpList
Array of String

"1.1.1.1","1.1.1.2"

IpAddType = 3(多地址添加模式)时需要填写,支持单个或多个 IP 地址。

返回参数

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

参数
类型
示例值
描述
Id
Integer

111229

规则 ID。

请求示例

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

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120203109226190241094C8EFC3",
    "Action": "CreateAclRule",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": 111229
  }
}

错误码

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

国内地理位置列表

Code地区
Anhui安徽
Beijing北京
Chongqing重庆
Fujian福建
Gansu甘肃
Guangdong广东
Guangxi广西
Guizhou贵州
Hainan海南
Hebei河北
Heilongjiang黑龙江
Henan河南
Hubei湖北
Hunan湖南
Inner Mongolia内蒙古
Jiangsu江苏
Jiangxi江西
Jilin吉林
Liaoning辽宁
Ningxia宁夏
Qinghai青海
Shaanxi陕西
Shandong山东
Shanghai上海
Shanxi山西
Sichuan四川
Tianjin天津
Tibet西藏
Xinjiang新疆
Yunnan云南
Zhejiang浙江
Taiwan Province台湾
Hong Kong香港
Macau澳门