{"base_path":"/","components":null,"consumes":"","definitions":{"Action":{"description":"用来保存网站反爬虫中特征反爬虫的防护动作信息","properties":{"category":{"description":"特征反爬虫中防护动作信息 \n - log:仅记录 \n - block:拦截","type":"string"}}},"BindHost":{"description":"绑定的域名信息","properties":{"hostname":{"description":"域名","type":"string"},"id":{"description":"域名ID","type":"string"},"mode":{"description":"仅独享模式涉及特殊域名模式","type":"string"},"waf_type":{"description":"域名对应模式:cloud(云模式)/premium(独享模式)","type":"string"}}},"CreatePolicyRequestBody":{"example":{"name":"demo"},"properties":{"log_action_replaced":{"description":"cc规则和精准防护规则“防护动作”选择“仅记录”时,Web基础防护是否命中策略规则并阻断,默认为true","type":"boolean"},"name":{"description":"策略名称(策略名称只能由数字、字母和下划线组成,长度不能超过64为字符)","type":"string"}},"required":["name"]},"CreatePolicyResponseBody":{"properties":{"action":{"$ref":"#/definitions/PolicyAction","description":"防护动作信息"},"bind_host":{"description":"与防护策略绑定的防护的域名信息数组,相对于hosts字段,包含更详细的域名信息","items":{"$ref":"#/definitions/BindHost"},"type":"array"},"extend":{"additionalProperties":{"type":"string"},"description":"扩展字段,用于存放Web基础防护中一些开关配置等信息","type":"object"},"full_detection":{"description":"精准防护中的检测模式。 \n - false:短路检测,当用户的请求符合精准防护中的拦截条件时,便立刻终止检测,进行拦截 \n - true :全检测,请求符合精准防护中的拦截条件时,全检测不会立即拦截,会继续执行其他防护的检测,最后进行拦截。","type":"boolean"},"hosts":{"description":"与防护策略绑定的防护的域名id数组","items":{"type":"string"},"type":"array"},"id":{"description":"防护策略id","type":"string"},"level":{"default":2,"description":"Web基础防护等级 \n - 1 : 宽松,防护粒度较粗,只拦截攻击特征比较明显的请求。当误报情况较多的场景下,建议选择“宽松”模式。 \n - 2:中等,默认为“中等”防护模式,满足大多数场景下的Web防护需求。 \n - 3:严格,防护粒度最精细,可以拦截具有复杂的绕过特征的攻击请求,例如jolokia网络攻击、探测CGI漏洞、探测 Druid SQL注入攻击","enum":[1,2,3],"type":"integer"},"modulex_options":{"additionalProperties":{"type":"object"},"description":"智能访问控制防护项相关配置信息,目前该特性还处于公测阶段,只有部分局点支持该特性","type":"object"},"name":{"description":"防护策略名","type":"string"},"options":{"$ref":"#/definitions/PolicyOption","description":"该参数存放防护策略里防护项的开关信息"},"robot_action":{"$ref":"#/definitions/Action","description":"用于存放网站反爬虫中特征反爬虫动作信息"},"timestamp":{"description":"创建防护策略的时间","format":"int64","type":"integer"}}},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"PolicyAction":{"description":"防护动作","example":{},"properties":{"category":{"description":"web基础防护动作(log为仅记录、block为拦截)","enum":["block","log"],"type":"string"},"followed_action_id":{"description":"攻击惩罚规则ID","type":"string"}}},"PolicyOption":{"description":"防护策略检测模块开关选项,如是否开启Web基础防护等","example":{},"properties":{"antileakage":{"description":"防敏感信息泄露规则是否开启","enum":[true,false],"type":"boolean"},"antitamper":{"description":"网页防篡改规则是否开启","enum":[true,false],"type":"boolean"},"bot_enable":{"description":"网站反爬虫总开关是否开启","enum":[true,false],"type":"boolean"},"cc":{"description":"cc规则是否开启","enum":[true,false],"type":"boolean"},"common":{"description":"常规检测是否开启","enum":[true,false],"type":"boolean"},"crawler":{"description":"预留参数,该参数值一直为true,用户可忽略该参数值","enum":[true,false],"type":"boolean"},"crawler_engine":{"description":"搜索engine是否开启","enum":[true,false],"type":"boolean"},"crawler_other":{"description":"其他爬虫是否开启","enum":[true,false],"type":"boolean"},"crawler_scanner":{"description":"反爬虫检测是否开启","enum":[true,false],"type":"boolean"},"crawler_script":{"description":"脚本反爬虫是否开启","enum":[true,false],"type":"boolean"},"custom":{"description":"精准防护是否开启","enum":[true,false],"type":"boolean"},"geoip":{"description":"地理位置访问控制规则是否开启","enum":[true,false],"type":"boolean"},"ignore":{"description":"误报屏蔽是否开启","enum":[true,false],"type":"boolean"},"modulex_enabled":{"description":"modulex智能cc防护是否开启,该特性是公测特性,在公测期间,只支持仅记录模式。","enum":[true,false],"type":"boolean"},"privacy":{"description":"隐私屏蔽是否开启","enum":[true,false],"type":"boolean"},"webattack":{"description":"基础防护是否开启","enum":[true,false],"type":"boolean"},"webshell":{"description":"Webshell检测是否开启","enum":[true,false],"type":"boolean"},"whiteblackip":{"description":"黑白名单防护是否开启","enum":[true,false],"type":"boolean"}}},"RestErrorResponse":{"properties":{"details":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。","items":{"$ref":"#/definitions/IAM5ErrorDetails"},"type":"array"},"encoded_authorization_message":{"description":"编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。","type":"string"},"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误信息","type":"string"}},"title":"RestErrorResponse","type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"ccc72eb7ea484d34923317d587389852","info_version":"v1","method":"post","name":"CreatePolicy","parameters":{},"paths":{"/v1/{project_id}/waf/policy":{"post":{"description":"创建防护策略,系统会在生成策略时配置一些默认的配置项,如果需要修改策略的默认配置项需要通过调用更新防护策略接口实现","operationId":"CreatePolicy","parameters":[{"description":"用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":"application/json;charset=utf8","description":"内容类型","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID","in":"path","name":"project_id","required":true,"type":"string"},{"description":"您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"创建防护策略请求体,只传防护策略名称,系统生成的防护策会自动生成一些默认配置","in":"body","name":"CreatePolicyRequestBody","required":true,"schema":{"$ref":"#/definitions/CreatePolicyRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"action":{"category":"log"},"bind_host":[],"extend":{},"full_detection":false,"hosts":[],"id":"38ff0cb9a10e4d5293c642bc0350fa6d","level":2,"name":"demo","options":{"antileakage":false,"antitamper":true,"bot_enable":true,"cc":true,"common":true,"crawler":true,"crawler_engine":false,"crawler_other":false,"crawler_scanner":true,"crawler_script":false,"custom":true,"geoip":true,"ignore":true,"modulex_enabled":false,"privacy":true,"webattack":true,"webshell":false,"whiteblackip":true},"timestamp":1650529538732}},"schema":{"$ref":"#/definitions/CreatePolicyResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"403":{"description":"资源配额不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"创建防护策略","tags":["防护策略管理"],"x-hybridcloud":true,"x-is-registered":"Y","x-request-examples-1":{"name":"demo"},"x-request-examples-description-1":"在项目id为project_id的项目中创建一个策略名称为demo的防护策略","x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/policy?enterprise_project_id=0","x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建防护策略","tags":"防护策略管理","uri":null,"version":"2.0"}