huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"CloudWafHostItem":{"properties":{"access_code":{"description":"cname前缀","type":"string"},"access_status":{"description":"域名接入状态,0表示未接入,1表示已接入","type":"integer"},"description":{"description":"域名描述信息,可选参数。","type":"string"},"enterprise_project_id":{"description":"企业项目id","type":"string"},"exclusive_ip":{"description":"是否使用独享ip \n - true:使用独享ip \n - false:不实用独享ip","type":"boolean"},"flag":{"$ref":"#/definitions/Flag","description":"特殊标识,用于前端使用"},"hostid":{"description":"域名id","type":"string"},"hostname":{"description":"创建的云模式防护域名","type":"string"},"id":{"description":"域名id","type":"string"},"paid_type":{"description":"套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。","type":"string"},"policyid":{"description":"防护策略id","type":"string"},"protect_status":{"description":"域名防护状态:\n - -1:bypass,该域名的请求直接到达其后端服务器,不再经过WAF\n - 0:暂停防护,WAF只转发该域名的请求,不做攻击检测\n - 1:开启防护,WAF根据您配置的策略进行攻击检测","type":"integer"},"proxy":{"description":"防护域名是否使用代理 \n - false:不使用代理 \n - true:使用代理","type":"boolean"},"region":{"description":"华为云区域ID,控制台创建的域名会携带此参数,api调用创建的域名此参数为空,可以通过华为云上地区和终端节点文档查询区域ID对应的中文名称","type":"string"},"server":{"description":"防护域名的源站服务器配置信息","items":{"$ref":"#/definitions/CloudWafServer"},"type":"array"},"timestamp":{"description":"创建防护域名的时间","format":"int64","type":"integer"},"type":{"description":"WAF部署模式,默认是1,目前仅支持反代模式,冗余参数","type":"integer"},"web_tag":{"description":"网站名称,对应WAF控制台域名详情中的网站名称","type":"string"}}},"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"]},"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"}}},"InstanceIdsStatus":{"example":{"instance_ids":["waf-instance-001-id"],"protect_status":0},"properties":{"instance_ids":{"items":{"type":"string"},"type":"array"},"protect_status":{"format":"int32","type":"integer"}},"type":"object"},"ListHostResponseBody":{"properties":{"items":{"description":"详细的云模式防护域名列表信息","items":{"$ref":"#/definitions/CloudWafHostItem"},"type":"array"},"total":{"description":"云模式防护域名的数量","type":"integer"}}},"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":"b849bd6627644c59bc2d9d7efc65afab","info_version":"v1","method":"put","name":"BatchUpdateProtectStatus","parameters":{},"paths":{"/v1/{project_id}/waf/instance/protect_status":{"put":{"description":"**参数解释:**\n批量修改防护状态\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","operationId":"BatchUpdateProtectStatus","parameters":[{"description":"**参数解释:**\n用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":"application/json;charset=utf8","description":"**参数解释:**\n内容类型\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\napplication/json;charset=utf8","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"**参数解释:**\n项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。\n**约束限制:**\n不涉及\n**取值范围:**\n只能由英文字母、数字组成,且长度为32个字符。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"description":"**参数解释:**\n您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:代表default企业项目\n - all_granted_eps:代表所有企业项目\n - 其它企业项目ID:长度为36个字符\n\n**默认取值:**\n0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"**参数解释:**\n批量修改域名防护状态请求体","in":"body","name":"instanceIdsStatus","required":true,"schema":{"$ref":"#/definitions/InstanceIdsStatus"}}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"**参数解释:**\n请求成功\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","examples":{"application/json":{"items":[{"access_code":"7d06456ffaexxxxxxxxxxx281bc13b","access_status":0,"description":"e","exclusive_ip":false,"flag":{"cname":"new","ipv6":"false","is_dual_az":"true","pci_3ds":"false","pci_dss":"false"},"hostid":"d0a4bc2f74e3407388a50243af700305","hostname":"www.demo.com","id":"d0a4bc2f74e3407388a50243af700305","paid_type":"prePaid","policyid":"bb2124fabe6f42ff9fe4770eeccb2670","protect_status":1,"proxy":false,"region":"cn-north-4","timestamp":1642648030687,"type":1,"web_tag":"iii"}],"total":1}},"schema":{"$ref":"#/definitions/ListHostResponseBody"}},"400":{"description":"**参数解释:**\n请求失败\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"**参数解释:**\ntoken权限不足\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"**参数解释:**\n服务器内部错误\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"**参数解释:**\n批量修改防护状态\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","tags":["云模式防护网站管理"],"x-api-type":"open-api","x-hybridcloud":false,"x-is-registered":"Y","x-order":6,"x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}/route?enterprise_project_id=0","x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"**参数解释:**\n批量修改防护状态\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","tags":"云模式防护网站管理","uri":null,"version":"2.0"}