{"base_path":"/","components":null,"consumes":"","definitions":{"BlockPage":{"description":"告警页面配置参数,用于配置“自定义”或者“重定向”页面","properties":{"custom_page":{"$ref":"#/definitions/CustomPage","description":"自定义告警页面"},"redirect_url":{"description":"“重定向”页面URL","type":"string"},"template":{"description":"模板名称,默认页面请输入default,自定义告警页面时请输入custom,重定向请输入redirect","type":"string"}},"required":["template"]},"CloudWafServer":{"description":"防护域名的源站服务器配置信息","properties":{"address":{"description":"客户端访问的源站服务器的IP地址","type":"string"},"back_protocol":{"description":"WAF转发客户端请求到防护域名源站服务器的协议","enum":["HTTP","HTTPS"],"type":"string"},"front_protocol":{"description":"客户端请求访问防护域名源站服务器的协议","enum":["HTTP","HTTPS"],"type":"string"},"port":{"description":"WAF转发客户端请求到源站服务的业务端口","type":"integer"},"type":{"description":"源站地址为ipv4或ipv6","enum":["ipv4","ipv6"],"type":"string"},"weight":{"description":"源站权重,负载均衡算法将按该权重将请求分配给源站,默认值是1,云模式的冗余字段","type":"integer"}},"required":["front_protocol","back_protocol","address","port","type"]},"CreateHostRequestBody":{"description":"域名请求体","example":{"certificateid":"3ac1402300374a63a05be68c641e92c8","certificatename":"test6","description":"demo","exclusive_ip":false,"hostname":"www.demo.com","paid_type":"prePaid","proxy":false,"server":[{"address":"x.x.x.x","back_protocol":"HTTP","front_protocol":"HTTPS","port":"7443","type":"ipv4"}],"web_tag":"demo"},"properties":{"certificateid":{"description":"证书id,通过查询证书列表接口(ListCertificates)接口获取证书id \n - 对外协议为HTTP时不需要填写 \n - 对外协议HTTPS时为必填参数","type":"string"},"certificatename":{"description":"证书名 \n - 对外协议为HTTP时不需要填写 \n - 对外协议HTTPS时为必填参数","type":"string"},"description":{"description":"域名描述","type":"string"},"exclusive_ip":{"description":"是否使用独享ip \n - true:使用独享ip \n - false:不实用独享ip","type":"boolean"},"forward_header_map":{"additionalProperties":{"type":"string"},"description":"字段转发配置,WAF会将添加的字段插到header中,转给源站;Key不能跟nginx原生字段重复。Value支持的值包括: \n - $time_local \n - $request_id \n - $connection_requests \n - $tenant_id \n - $project_id \n - $remote_addr \n - $remote_port \n - $scheme \n - $request_method \n - $http_host \n -$origin_uri \n - $request_length \n - $ssl_server_name \n - $ssl_protocol \n - $ssl_curves \n - $ssl_session_reused","type":"object"},"hostname":{"description":"域名(域名只能由字母、数字、-、_和.组成,长度不能超过64个字符,如www.domain.com)","type":"string"},"lb_algorithm":{"description":"LB负载均衡,仅专业版(原企业版)和铂金版(原旗舰版)支持配置负载均衡算法 \n - 源IP Hash:将某个IP的请求定向到同一个服务器 \n - 加权轮询:所有请求将按权重轮流分配给源站服务器 \n - Session Hash:将某个Session标识的请求定向到同一个源站服务器,请确保在域名添加完毕后配置攻击惩罚的流量标识,否则Session Hash配置不生效","enum":["ip_hash","round_robin","session_hash"],"type":"string"},"paid_type":{"description":"套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。","type":"string"},"policyid":{"description":"防护域名初始绑定的策略ID,可以通过策略名称调用查询防护策略列表(ListPolicy)接口查询到对应的策略id","type":"string"},"proxy":{"description":"防护域名是否使用代理 \n - false:不使用代理 \n - true:使用代理","type":"boolean"},"server":{"description":"防护域名的源站服务器配置信息","items":{"$ref":"#/definitions/CloudWafServer"},"type":"array"},"web_tag":{"description":"网站名称,对应WAF控制台域名详情中的网站名称","type":"string"}},"required":["hostname","proxy","server"]},"CreateHostResponseBody":{"properties":{"access_code":{"description":"cname前缀","type":"string"},"access_status":{"description":"域名接入状态,0表示未接入,1表示已接入","type":"integer"},"block_page":{"$ref":"#/definitions/BlockPage","description":"告警页面配置"},"certificateid":{"description":"返回的证书id","type":"string"},"certificatename":{"description":"证书名称","type":"string"},"exclusive_ip":{"description":"是否使用独享ip \n - true:使用独享ip \n - false:不实用独享ip","type":"boolean"},"extend":{"additionalProperties":{"type":"string"},"description":"扩展字段,用于保存防护域名的一些配置信息。","type":"object"},"flag":{"$ref":"#/definitions/Flag","description":"特殊标识,用于前端使用"},"forward_header_map":{"additionalProperties":{"type":"string"},"description":"字段转发配置,WAF会将添加的字段插到header中,转给源站;Key不能跟nginx原生字段重复。Value支持的值包括: \n - $time_local \n - $request_id \n - $connection_requests \n - $tenant_id \n - $project_id \n - $remote_addr \n - $remote_port \n - $scheme \n - $request_method \n - $http_host \n -$origin_uri \n - $request_length \n - $ssl_server_name \n - $ssl_protocol \n - $ssl_curves \n - $ssl_session_reused","type":"object"},"hostname":{"description":"创建的云模式防护域名","type":"string"},"http2_enable":{"description":"是否支持http2 \n - true:表示支持http2 \n - false:表示不支持http2","type":"boolean"},"id":{"description":"域名id","type":"string"},"lb_algorithm":{"description":"LB负载均衡,仅专业版(原企业版)和铂金版(原旗舰版)支持配置负载均衡算法 \n - 源IP Hash:将某个IP的请求定向到同一个服务器 \n - 加权轮询:所有请求将按权重轮流分配给源站服务器 \n - Session Hash:将某个Session标识的请求定向到同一个源站服务器,请确保在域名添加完毕后配置攻击惩罚的流量标识,否则Session Hash配置不生效","enum":["ip_hash","round_robin","session_hash"],"type":"string"},"policyid":{"description":"策略id","type":"string"},"protect_status":{"description":"域名防护状态:\n - -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF\n - 0:暂停防护,WAF只转发该域名的请求,不做攻击检测\n - 1:开启防护,WAF根据您配置的策略进行攻击检测","type":"integer"},"protocol":{"description":"返回的客户端协议类型","type":"string"},"proxy":{"description":"防护域名是否使用代理 \n - false:不使用代理 \n - true:使用代理","type":"boolean"},"server":{"description":"防护域名的源站服务器配置信息","items":{"$ref":"#/definitions/CloudWafServer"},"type":"array"},"timestamp":{"description":"创建防护域名的时间","format":"int64","type":"integer"},"web_tag":{"description":"网站名称,对应WAF控制台域名详情中的网站名称","type":"string"}}},"CustomPage":{"description":"自定义告警页面","properties":{"content":{"description":"根据选择的“页面类型”配置对应的页面内容,具体示例可以参考“Web应用防火墙 WAF”用户手册","type":"string"},"content_type":{"description":"“自定义”告警页面内容类型,可选择text/html、text/xml和application/json三种类型","type":"string"},"status_code":{"description":"返回状态码","type":"string"}},"required":["status_code","content_type","content"]},"Flag":{"description":"特殊标识,用于前端使用","properties":{"cname":{"description":"old:代表域名使用的老的cname,new:代表域名使用新的cname","enum":["old","new"],"type":"string"},"ipv6":{"description":"域名是否开启ipv6 \n - true:支持 \n - false:不支持","enum":["true","false"],"type":"string"},"is_dual_az":{"description":"域名是否开启ipv6 \n - true:支持 \n - false:不支持","enum":["true","false"],"type":"string"},"pci_3ds":{"description":"是否开启pci_3ds合规认证 \n - true:开启 \n - false:不开启","enum":["true","false"],"type":"string"},"pci_dss":{"description":"是否开启pci_dss合规认证 \n - true:开启 \n - false:不开启","enum":["true","false"],"type":"string"}}},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"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":"210ee6b480c0462a81be495f14cb9642","info_version":"v1","method":"post","name":"CreateHost","parameters":{},"paths":{"/v1/{project_id}/waf/instance":{"post":{"description":"创建云模式防护域名","operationId":"CreateHost","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"},{"default":"","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":"CreateHostRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateHostRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"access_code":"1b18879b9d064f8bbcbf8abce7294cac","access_status":0,"block_page":{"template":"default"},"exclusive_ip":false,"flag":{"cname":"new","ipv6":"false","is_dual_az":"true","pci_3ds":"false","pci_dss":"false"},"hostname":"www.demo.com","http2_enable":false,"id":"31af669f567246c289771694f2112289","policyid":"41cba8aee2e94bcdbf57460874205494","protect_status":1,"protocol":"HTTP","proxy":false,"server":[{"address":"x.x.x.x","back_protocol":"HTTP","front_protocol":"HTTP","port":80,"type":"ipv4","weight":1}],"timestamp":1650527546420,"web_tag":""}},"schema":{"$ref":"#/definitions/CreateHostResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"创建云模式防护域名","tags":["云模式防护网站管理"],"x-hybridcloud":false,"x-is-registered":"Y","x-request-examples-1":{"certificateid":"3ac1402300374a63a05be68c641e92c8","certificatename":"test6","description":"demo","exclusive_ip":false,"hostname":"www.demo.com","paid_type":"prePaid","proxy":false,"server":[{"address":"x.x.x.x","back_protocol":"HTTP","front_protocol":"HTTPS","port":"7443","type":"ipv4"}],"web_tag":"demo"},"x-request-examples-description-1":"在项目id为project_id的项目下,创建域名是“www.demo.com”的云模式防护域名,该域名的客户端请求访问防护域名源站服务器的协议是“HTTPS”,WAF转发客户端请求到防护域名源站服务器的协议是“HTTP”,源站地址是“ipv4”,源站服务器的IP地址是“x.x.x.x”,WAF转发客户端请求到源站服务的业务端口是\"7443\",该域名不使用代理和独享ip,套餐付费模式是包周期款模式,域名描述是“dome”,对应WAF控制台域名详情中的网站名称是“dome”,对外协议的证书名称是“test6”,证书id是“3ac1402300374a63a05be68c641e92c8”。","x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/instance?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"}