您可以使用 CreateAclRule 接口创建访问管控规则,管控指定 IP 地址的访问。支持设置对应的允许访问名单和禁止访问名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateAclRule | 要执行的操作,取值:CreateAclRule。 |
Version | String | 是 | 2023-12-25 | API的版本,取值:2023-12-25。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | observe | 执行动作。
|
HostGroupId | Array of Integer | 否 | 7436 | 域名组 ID, |
Description | String | 否 | 禁止特定 IP 访问。 | 规则描述。 |
Name | String | 是 | 访问控制1 | 规则名称。
|
IpLocationCountry | Array of String | 否 | "US","JP" | 海外国家或地区代码,
|
IpLocationSubregion | Array of String | 否 | "Anhui","Guangdong" | 国内地区代码,
|
AccurateGroup | Object | 否 | -- | 高级条件,未配置时无需设置。 |
Url | String | 是 | /path | 匹配路径。支持通配符
|
PrefixSwitch | Integer | 否 | 0 | 是否开启前缀匹配。默认关闭。
|
IpAddType | Integer | 是 | 4 | IP 地址添加方式。
|
HostAddType | Integer | 是 | 2 | 域名添加方式。
|
Enable | Integer | 是 | 1 | 是否启用规则。
|
Advanced | Integer | 否 | 1 | 是否设置高级条件。默认为否。
|
AclType | String | 是 | Block | 访问管控规则类型。
|
HostList | Array of String | 否 | "*.test.com","www.test.com" |
|
IpGroupId | Array of Integer | 否 | 6283 |
|
IpList | Array of String | 否 | "1.1.1.1","1.1.1.2" |
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 澳门 |