华为云用户手册

  • 响应示例 状态码: 200 ok { "action" : { "category" : "block" }, "action_mode" : false, "conditions" : [ { "category" : "header", "index" : "demo2", "logic_operation" : "contain", "contents" : [ "demo" ] } ], "description" : "", "name" : "test55", "id" : "2a3caa2bc9814c09ad73d02e3485b4a4", "policyid" : "1f016cde588646aca3fb19f277c44d03", "priority" : 50, "status" : 1, "time" : false }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 内容类型 缺省值:application/json;charset=utf8 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 规则名称 time 是 Boolean 精准防护规则生效时间: “false”:表示该规则立即生效。 “true”:表示自定义生效时间。 start 否 Long 精准防护规则生效的起始时间戳(秒)。当time=true,才需要填写该参数。 terminal 否 Long 精准防护规则生效的终止时间戳(秒)。当time=true,才需要填写该参数。 description 否 String 规则描述 conditions 是 Array of CustomConditions objects 匹配条件列表 action 是 CustomAction object 精准防护规则命中后操作对象 priority 是 Integer 执行该规则的优先级,值越小,优先级越高,值相同时,规则创建时间早,优先级越高。取值范围:0到1000。 表5 CustomConditions 参数 是否必选 参数类型 描述 category 否 String 字段类型。可选值为:url、user-agent、ip、params、cookie、referer、header、request_line、method、request 枚举值: url user-agent referer ip method request_line request params cookie header index 否 String 子字段: 字段类型为url、user-agent、ip、refer、request_line、method、request时,不需要传index参数 字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段 logic_operation 否 String 条件列表匹配逻辑。 如果字段类型category是url、user-agent或者referer, 匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、 not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal或者len_not_equal 如果字段类型category是ip, 匹配逻辑可以为: equal、not_equal、equal_any或者not_equal_all 如果字段类型category是method, 匹配逻辑可以为: equal或者not_equal n - 如果字段类型category是request_line或者request, 匹配逻辑可以为: len_greater、len_less、len_equal或者len_not_equal 如果字段类型category是params、cookie或者header, 匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、 not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal、len_not_equal、、num_greater、num_less、num_equal、num_not_equal、exist或者not_exist contents 否 Array of strings 条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时,需要传该参数。 value_list_id 否 String 引用表id。当logic_operation参数以any或者all结尾时,需要传该参数。此外,引用表类型要与category类型保持一致。 表6 CustomAction 参数 是否必选 参数类型 描述 category 是 String 操作类型。 “block”:拦截。 “pass”:放行。 “log”:仅记录 枚举值: block pass log followed_action_id 否 String 攻击惩罚规则id,只有当category参数值为block时才可配置该参数
  • 响应消息体(可选) 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxxxxxxx", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 黑白名单规则条数 items Array of WhiteBlackIpResponseBody objects 黑白名单规则列表信息 表5 WhiteBlackIpResponseBody 参数 参数类型 描述 id String 规则id name String 黑白名单规则名称 policyid String 策略id timestamp Long 创建规则的时间戳(毫秒) description String 规则描述 status Integer 规则状态,0:关闭,1:开启 addr String Ip/Ip段 white Integer 防护动作: 0拦截 1放行 2仅记录 ip_group Ip_group object Ip地址组 表6 Ip_group 参数 参数类型 描述 id String Ip地址组id,在新增Ip地址组时系统自动生成的唯一标识 name String Ip地址组名 size Long Ip地址组中包含Ip/Ip段的数量 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 OK { "total" : 1, "items" : [ { "id" : "3c96caf769ca4f57814fcf4259ea89a1", "policyid" : "4dddfd44fc89453e9fd9cd6bfdc39db2", "name" : "hkhtest", "timestamp" : 1650362891844, "description" : "demo", "status" : 1, "addr" : "x.x.x.x", "white" : 0 } ] }
  • 概述 Web应用防火墙 (Web Application Firewall,WAF),通过对HTTP(S)请求进行检测,识别并阻断SQL注入、跨站脚本攻击、网页木马上传、命令/代码注入、文件包含、敏感文件访问、第三方应用漏洞攻击、CC攻击、恶意爬虫扫描、跨站请求伪造等攻击,保护Web服务安全稳定。 您可以使用本文档提供的API对WAF进行相关操作,如查询、更新等操作。 在调用WAF API之前,请确保已经充分了解WAF,有关WAF服务的详细介绍,请参见Web应用防火墙。 父主题: 使用前必读
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 内容类型 缺省值:application/json;charset=utf8 表4 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 地理位置控制规则名称 geoip 是 String 地理位置封禁区域: (CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Thailand: 泰国,Singapore: 新加坡,South Africa: 南非,Mexico: 墨西哥,Peru: 秘鲁,Indonesia: 印度尼西亚,GD: 广东,FJ: 福建,JL: 吉林,LN: 辽宁,TW: 中国-台湾,GZ: 贵州,AH: 安徽,HL: 黑龙江,HA: 河南,SC: 四川,HE: 河北,YN: 云南,HB: 湖北,HI: 海南,QH: 青海,HN: 湖南,JX: 江西,SX: 山西,SN: 陕西,ZJ: 浙江,GS: 甘肃,JS: 江苏,SD: 山东,BJ: 北京,SH: 上海,TJ: 天津,CQ: 重庆,MO: 中国-澳门,HK: 中国-香港,NX: 宁夏,GX: 广西,XJ: 新疆,XZ: 西藏,NM: 内蒙古)。具体的位置编码参见《附录-地理位置编码》查询。 white 是 Integer 防护动作: 0 拦截 1 放行 2 仅记录 status 否 Integer 规则状态,0:关闭,1:开启 description 否 String 规则描述
  • 响应示例 状态码: 200 OK { "id" : "02dafa406c4941368a1037b020f15a53", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "timestamp" : 1650534513775, "status" : 1, "geoip" : "SH|Afghanistan", "white" : 0 }
  • 请求示例 在项目id为project_id,防护策略id为policy_id的防护策略下创建地理位置控制规则,地理位置控制规则的防护动作为拦截,规则描述为”demo“,规则名称为”demo“,地理位置封禁区域为上海和和阿富汗。 POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?enterprise_project_id=0 { "white" : 0, "description" : "demo", "name" : "demo", "geoip" : "SH|Afghanistan" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String 规则id name String 地理位置控制规则名称 policyid String 策略id geoip String 地理位置封禁区域: (CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Thailand: 泰国,Singapore: 新加坡,South Africa: 南非,Mexico: 墨西哥,Peru: 秘鲁,Indonesia: 印度尼西亚,GD: 广东,FJ: 福建,JL: 吉林,LN: 辽宁,TW: 中国-台湾,GZ: 贵州,AH: 安徽,HL: 黑龙江,HA: 河南,SC: 四川,HE: 河北,YN: 云南,HB: 湖北,HI: 海南,QH: 青海,HN: 湖南,JX: 江西,SX: 山西,SN: 陕西,ZJ: 浙江,GS: 甘肃,JS: 江苏,SD: 山东,BJ: 北京,SH: 上海,TJ: 天津,CQ: 重庆,MO: 中国-澳门,HK: 中国-香港,NX: 宁夏,GX: 广西,XJ: 新疆,XZ: 西藏,NM: 内蒙古)。具体的位置编码参见《附录-地理位置编码》查询。 white Integer 防护动作: 0 拦截 1 放行 2 仅记录 status Integer 规则状态,0:关闭,1:开启 timestamp Long 创建规则时间戳 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 OK { "total" : 1, "items" : [ { "id" : "06f07f6c229141b9a4a78614751bb687", "policyid" : "2abeeecefb9840e6bf05efbd80d0fcd7", "timestamp" : 1636340038062, "status" : 1, "geoip" : "GD", "white" : 1, "name" : "demo" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 该策略下地理位置控制规则数量 items Array of GeOIpItem objects 地理位置控制规则数组 表5 GeOIpItem 参数 参数类型 描述 id String 规则id policyid String 策略id name String 地理位置控制规则名称 geoip String 地理位置封禁区域: (CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Thailand: 泰国,Singapore: 新加坡,South Africa: 南非,Mexico: 墨西哥,Peru: 秘鲁,Indonesia: 印度尼西亚,GD: 广东,FJ: 福建,JL: 吉林,LN: 辽宁,TW: 中国-台湾,GZ: 贵州,AH: 安徽,HL: 黑龙江,HA: 河南,SC: 四川,HE: 河北,YN: 云南,HB: 湖北,HI: 海南,QH: 青海,HN: 湖南,JX: 江西,SX: 山西,SN: 陕西,ZJ: 浙江,GS: 甘肃,JS: 江苏,SD: 山东,BJ: 北京,SH: 上海,TJ: 天津,CQ: 重庆,MO: 中国-澳门,HK: 中国-香港,NX: 宁夏,GX: 广西,XJ: 新疆,XZ: 西藏,NM: 内蒙古)。具体的位置编码参见《附录-地理位置编码》查询。 white Integer 防护动作: 0 拦截 1 放行 2 仅记录 status Integer 规则状态,0:关闭,1:开启 timestamp Long 创建规则时间戳 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 攻击事件数量 items Array of ShowEventItems objects 攻击事件详情 表5 ShowEventItems 参数 参数类型 描述 time Long 攻击发生时的时间戳(毫秒) policyid String 策略id sip String 源ip,Web访问者的IP地址(攻击者IP地址) host String 域名 url String 攻击的url链接 attack String 攻击类型 rule String 命中的规则id action String 防护动作 cookie String 攻击请求的cookie headers Object 攻击请求的headers host_id String 被攻击的域名id id String 防护事件id payload String 恶意负载 payload_location String 恶意负载位置 region String 源ip地理位置 process_time Integer 处理时长 request_line String 攻击请求的请求行 response_size Integer 返回大小(字节) response_time Long 响应时间(毫秒) status String 响应码 request_body String 请求体 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 ok { "total" : 1, "items" : [ { "id" : "09-0000-0000-0000-12120220421093806-a60a6166", "time" : 1650505086000, "policyid" : "173ed802272a4b0798049d7edffeff03", "host" : "x.x.x.x:xxxxxx-xxx-xxx-xxx-xxxxxxxxx", "url" : "/mobile/DBconfigReader.jsp", "attack" : "vuln", "rule" : "091004", "payload" : " /mobile/dbconfigreader.jsp", "payload_location" : "uri", "sip" : "x.x.x.x", "action" : "block", "request_line" : "GET /mobile/DBconfigReader.jsp", "headers" : { "ls-id" : "c0d957e6-26a8-4f2e-8216-7fc9332a250f", "host" : "x.x.x.x:81", "lb-id" : "68d3c435-2607-45e0-a5e2-38980544dd45", "accept-encoding" : "gzip", "user-agent" : "Mozilla/5.0 (Windows NT 10.0; rv:78.0) Gecko/20100101 CS IRTx/2022" }, "cookie" : "HWWAFSESID=2a0bf76a111c93926d; HWWAFSESTIME=1650505086260", "status" : "418", "region" : "Reserved IP", "host_id" : "e093a352fd3a4ddd994c585e2e1dda59", "response_time" : 0, "response_size" : 3318, "process_time" : 0, "request_body" : "{}" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 source_ip Array of IpsItem objects 源站信息列表 last_modify Long 回源IP最后更新时间 表4 IpsItem 参数 参数类型 描述 ips Array of strings waf回源IP update_time Long 回源IP更新时间 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 请求成功 { "id" : "16e81d9a9e0244359204d7f00326ee4f", "policyid" : "0681f69f94ac408e9688373e45a61fdb", "timestamp" : 1679106005786, "description" : "", "status" : 1, "rule" : "webshell;vuln", "mode" : 1, "conditions" : [ { "category" : "url", "contents" : [ "/test" ], "logic_operation" : "contain" } ], "domain" : [ ], "advanced" : { "index" : "params", "contents" : [ ] } }
  • 请求示例 在项目id为project_id,防护策略id为policy_id的防护策略下创建隐私屏蔽防护规则,隐私屏蔽规则防护的url为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo”,规则描述为“demo”。 POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?enterprise_project_id=0 { "url" : "/demo", "category" : "cookie", "index" : "demo", "description" : "demo" }
  • 响应示例 状态码: 200 请求成功 { "id" : "97e4d35f375f4736a21cccfad77613eb", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "timestamp" : 1650533191385, "description" : "demo", "status" : 1, "url" : "/demo", "category" : "cookie", "index" : "demo" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String 规则id policyid String 策略id timestamp Long 创建规则的时间,格式为13位毫秒时间戳 status Integer 规则状态,0:关闭,1:开启 url String 隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/,以""号结尾代表路径前缀 category String 屏蔽字段 Params:请求参数 Cookie:根据Cookie区分的Web访问者 Header:自定义HTTP首部 Form:表单参数 枚举值: params cookie header form index String 屏蔽字段名,根据“屏蔽字段”设置字段名,被屏蔽的字段将不会出现在日志中。 description String 规则描述,可选参数,设置该规则的备注信息。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 内容类型 缺省值:application/json;charset=utf8 表4 请求Body参数 参数 是否必选 参数类型 描述 url 是 String 隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/,以""(星号)结尾代表路径前缀 category 是 String 屏蔽字段 Params:请求参数 Cookie:根据Cookie区分的Web访问者 Header:自定义HTTP首部 Form:表单参数 枚举值: params cookie header form index 是 String 屏蔽字段名,根据“屏蔽字段”设置字段名,被屏蔽的字段将不会出现在日志中。屏蔽字段名的长度不能超过2048字节,且只能由数字、字母、下划线和中划线组成。 description 否 String 规则描述,可选参数,设置该规则的备注信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 规则id policyid String 策略id geoip String 地理位置封禁区域: (CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Thailand: 泰国,Singapore: 新加坡,South Africa: 南非,Mexico: 墨西哥,Peru: 秘鲁,Indonesia: 印度尼西亚,GD: 广东,FJ: 福建,JL: 吉林,LN: 辽宁,TW: 中国-台湾,GZ: 贵州,AH: 安徽,HL: 黑龙江,HA: 河南,SC: 四川,HE: 河北,YN: 云南,HB: 湖北,HI: 海南,QH: 青海,HN: 湖南,JX: 江西,SX: 山西,SN: 陕西,ZJ: 浙江,GS: 甘肃,JS: 江苏,SD: 山东,BJ: 北京,SH: 上海,TJ: 天津,CQ: 重庆,MO: 中国-澳门,HK: 中国-香港,NX: 宁夏,GX: 广西,XJ: 新疆,XZ: 西藏,NM: 内蒙古)。具体的位置编码参见《附录-地理位置编码》查询。 white Integer 防护动作: 0 拦截 1 放行 2 仅记录 status Integer 规则状态,0:关闭,1:开启 timestamp Long 创建规则时间戳 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 地址组id name String 地址组名称 ips String 地址组ip(以逗号分隔的ip或ip段) size Integer 地址组长度 rules Array of RuleInfo objects ip地址组绑定的规则列表 share_info ShareInfo object 共享信息 description String 地址组描述 表5 RuleInfo 参数 参数类型 描述 rule_id String 规则id rule_name String 规则名称 policy_id String 策略id policy_name String 策略名称 表6 ShareInfo 参数 参数类型 描述 share_count Integer 共享用户数 accept_count Integer 接受用户数 process_status Integer 处理状态 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 更新项目id为project_id,lts配置信息id为c89a667487734f6a95e9967d1f373c77的全量日志lts信息。全量日志lts开启全量日志,日志组id为"4bcff74d-f649-41c8-8325-1b0a264ff683",访问日志流id为:"0a7ef713-cc3e-418d-abda-85df04db1a3c",攻击日志流id "f4fa07f6-277b-4e4a-a257-26508ece81e6"。 GET https://{Endpoint}/v1/{project_id}/waf/config/lts/c89a667487734f6a95e9967d1f373c77?enterprise_project_id=0 { "enabled" : true, "ltsIdInfo" : { "ltsAccessStreamID" : "4bcff74d-f649-41c8-8325-1b0a264ff683", "ltsAttackStreamID" : "0a7ef713-cc3e-418d-abda-85df04db1a3c", "ltsGroupId" : "f4fa07f6-277b-4e4a-a257-26508ece81e6" } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 id String lts配置信息id enabled Boolean 是否开启全量日志 false: 不开启 true: 开启 ltsIdInfo LtsIdInfo object 日志组与日志流id信息 enabale Boolean 该参数已废弃,请忽略 表7 LtsIdInfo 参数 参数类型 描述 ltsGroupId String 日志组id ltsAccessStreamID String 访问日志流id ltsAttackStreamID String 攻击日志流id 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 请求成功 { "enabled" : true, "id" : "c89a667487734f6a95e9967d1f373c77", "ltsIdInfo" : { "ltsAccessStreamID" : "4bcff74d-f649-41c8-8325-1b0a264ff683", "ltsAttackStreamID" : "0a7ef713-cc3e-418d-abda-85df04db1a3c", "ltsGroupId" : "f4fa07f6-277b-4e4a-a257-26508ece81e6" } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 内容类型 缺省值:application/json;charset=utf8 表4 请求Body参数 参数 是否必选 参数类型 描述 enabled 否 Boolean 是否开启全量日志 false: 不开启 true: 开启 ltsIdInfo 否 LtsIdInfo object 日志组与日志流id信息 enabale 否 Boolean 该参数已废弃,请忽略 表5 LtsIdInfo 参数 是否必选 参数类型 描述 ltsGroupId 否 String 日志组id ltsAccessStreamID 否 String 访问日志流id ltsAttackStreamID 否 String 攻击日志流id
  • 响应示例 状态码: 200 请求成功 { "type" : 3, "resources" : [ { "resourceId" : "b860a37b55df4d40b56c1582719661dd", "cloudServiceType" : "hws.service.type.waf", "resourceType" : "hws.resource.type.waf.instance", "resourceSpecCode" : "waf.instance.professional", "resourceSize" : null, "expireTime" : "2022-11-08T15:59:59Z", "status" : 0 }, { "resourceId" : "d2759a06ed844b9c9837bb76326ca656", "cloudServiceType" : "hws.service.type.waf", "resourceType" : "hws.resource.type.waf", "resourceSpecCode" : "waf.enterprise", "resourceSize" : null, "expireTime" : "2022-12-07T15:59:59Z", "status" : 0 }, { "resourceId" : "6a5a4b06dbcd4cc5be6ff88bcd988046", "cloudServiceType" : "hws.service.type.waf", "resourceType" : "hws.resource.type.waf.rule", "resourceSpecCode" : "waf.expack.rule.enterprise", "resourceSize" : 5, "expireTime" : "2022-12-07T15:59:59Z", "status" : 0 }, { "resourceId" : "a9202ca8704740b6a1e0481c80bd4255", "cloudServiceType" : "hws.service.type.waf", "resourceType" : "hws.resource.type.waf.domain", "resourceSpecCode" : "waf.expack.domain.enterprise", "resourceSize" : 10, "expireTime" : "2022-12-07T15:59:59Z", "status" : 0 } ], "isNewUser" : false, "premium" : { "purchased" : true, "total" : 8, "elb" : 0, "dedicated" : 8 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 type Integer 云模式版本 -2:已冻结 -1:未订购 2:标准版 3:专业版 4:铂金版 7: 入门版 22:按需版本 resources Array of ResourceResponse objects 资源列表 isNewUser Boolean 是否为新用户 premium Premium object 独享模式订购信息 表4 ResourceResponse 参数 参数类型 描述 resourceId String 资源id cloudServiceType String 云服务产品对应的云服务类型 resourceType String 云服务产品的资源类型 hws.resource.type.waf.payperuserequest : Web应用防火墙按需请求 hws.resource.type.waf.payperusedomain:Web应用防火墙按需域名 hws.resource.type.waf.payperuserule: Web应用防火墙按需规则 resourceSpecCode String 云服务产品的资源规格 status Integer 资源状态 0:解冻/正常 1:冻结 2:删除 expireTime String 资源到期时间 resourceSize Integer 资源数量 表5 Premium 参数 参数类型 描述 purchased Boolean 是否开通独享模式 total Integer 独享实例数量,包括elb elb Integer elb实例数量 dedicated Integer 独享WAF实例数量 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 更新项目id为project_id,防护策略id为policy_id,规则id为rule_id的的JS脚本反爬虫规则,规则名称为“test66”,JS脚本反爬虫规则类型为排除防护路径,匹配条为url包含“/test66”,执行该规则的优先级为50。 PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/anticrawler/{rule_id}? { "name" : "test66", "type" : "anticrawler_except_url", "conditions" : [ { "category" : "url", "logic_operation" : "contain", "contents" : [ "/test66" ] } ], "priority" : 50 }
  • 响应示例 状态码: 200 ok { "id" : "7e7983bf2c9c41029d642bcbf819346d", "policyid" : "0681f69f94ac408e9688373e45a61fdb", "name" : "test66", "timestamp" : 1678931492172, "status" : 1, "type" : "anticrawler_except_url", "conditions" : [ { "category" : "url", "contents" : [ "/test66" ], "logic_operation" : "contain" } ], "priority" : 50 }
共100000条