huawei-cloud-api-definitions-WAF 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"CreateGeoIpRuleRequestBody":{"properties":{"description":{"description":"规则描述","type":"string"},"geoip":{"description":"地理位置封禁区域,选择区域对应的字母代号,用中划线|分隔:\n(CN: 中国,CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Ukraine: 乌克兰,North Korea: 朝鲜,The Republic of Korea: 韩国,Iran: 伊朗,Cuba: 古巴,Sultan: 苏丹,Syria: 叙利亚,Pakistan: 巴基斯坦,Palestine: 巴勒斯坦,Israel: 以色列,Iraq: 伊拉克,Afghanistan: 阿富汗,Libya: 利比亚,Turkey: 土耳其,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: 内蒙古)","type":"string"},"name":{"description":"地理位置控制规则名称","type":"string"},"status":{"description":"规则状态,0:关闭,1:开启","type":"integer"},"white":{"description":"防护动作:\n - 0 拦截\n - 1 放行\n - 2 仅记录","type":"integer"}},"required":["geoip","white"]},"CreateGeoIpRuleResponseBody":{"properties":{"geoip":{"description":"地理位置封禁区域:\n(CN: 中国,,CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Ukraine: 乌克兰,North Korea: 朝鲜,The Republic of Korea: 韩国,Iran: 伊朗,Cuba: 古巴,Sultan: 苏丹,Syria: 叙利亚,Pakistan: 巴基斯坦,Palestine: 巴勒斯坦,Israel: 以色列,Iraq: 伊拉克,Afghanistan: 阿富汗,Libya: 利比亚,Turkey: 土耳其,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: 内蒙古)","type":"string"},"id":{"description":"规则id","type":"string"},"name":{"description":"地理位置控制规则名称","type":"string"},"policyid":{"description":"策略id","type":"string"},"status":{"description":"规则状态,0:关闭,1:开启","type":"integer"},"timestamp":{"description":"创建规则时间戳","format":"int64","type":"integer"},"white":{"description":"防护动作:\n - 0 拦截\n - 1 放行\n - 2 仅记录","type":"integer"}},"type":"object"},"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":"bb555efc3c7045aa90b0295934e19b40","info_version":"v1","method":"post","name":"CreateGeoipRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/geoip":{"post":{"description":"创建地理位置控制规则","operationId":"CreateGeoipRule","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"},{"default":"","description":"防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id","in":"path","name":"policy_id","required":true,"type":"string"},{"description":"创建地理访问控制请求体","in":"body","name":"CreateGeoIpRuleRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateGeoIpRuleRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"geoTagList":["SH","Afghanistan"],"geoip":"SH|Afghanistan","id":"02dafa406c4941368a1037b020f15a53","name":"demo","policyid":"38ff0cb9a10e4d5293c642bc0350fa6d","status":1,"timestamp":1650534513775,"white":0}},"schema":{"$ref":"#/definitions/CreateGeoIpRuleResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"创建地理位置控制规则","tags":["策略规则管理"],"x-hybridcloud":true,"x-is-registered":"Y","x-request-examples-1":{"description":"demo","geoip":"SH|Afghanistan","name":"demo","white":0},"x-request-examples-description-1":"在项目id为project_id,防护策略id为policy_id的防护策略下创建地理位置控制规则,地理位置控制规则的防护动作为拦截,规则描述为”demo“,规则名称为”demo“,地理位置封禁区域为上海和和伊拉克。","x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?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"}