huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"GeOIpItem":{"description":"地理位置控制规则","properties":{"geoip":{"description":"地理位置封禁区域","type":"string"},"id":{"description":"规则id","type":"string"},"name":{"description":"地理位置控制规则名称","type":"string"},"policyid":{"description":"策略id","type":"string"},"status":{"description":"**参数解释:**\n规则状态标识,用于指定规则的启用或关闭状态\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:关闭\n - 1:开启\n**默认取值:**\n不涉及","enum":[0,1],"type":"integer"},"timestamp":{"description":"创建规则时间戳","format":"int64","type":"integer"},"white":{"description":"防护动作:\n - 0 拦截\n - 1 放行\n - 2 仅记录","type":"integer"}}},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"ListGeoIpResponseBody":{"example":{"items":[{"description":"ab","geoTagList":["BJ"],"geoip":"BJ","id":"75c7f0a9f98d4fdd81867a5033cffcf9","ip_type":"v4","name":"a","policyid":"c9c04ca613c848dc90db828830ab2ab2","policyname":"policy_1b0fa6","status":1,"timestamp":1757990377375,"white":0}],"total":201},"properties":{"items":{"description":"地理位置控制规则数组","items":{"$ref":"#/definitions/GeOIpItem"},"type":"array"},"total":{"description":"该策略下地理位置控制规则数量","type":"integer"}},"type":"object"},"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":"200a09c9f54d4d86962b01fa40f86a03","info_version":"v1","method":"get","name":"ListGeoIpPolicyRules","parameters":{},"paths":{"/v1/{project_id}/waf/rule/geoip":{"get":{"description":"查询所有策略地理位置访问控制","operationId":"ListGeoIpPolicyRules","parameters":[{"description":"**参数解释:**\n项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。\n**约束限制:**\n不涉及\n**取值范围:**\n只能由英文字母、数字组成,且长度为32个字符。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"default":"0","description":"**参数解释:**\n您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:代表default企业项目\n - all_granted_eps:代表所有企业项目\n - 其它企业项目ID:长度为36个字符\n**默认取值:**\n0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"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"},{"collectionFormat":"multi","description":"**参数解释:**\n防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"query","items":{"type":"string"},"name":"policyids","required":false,"type":"array","uniqueItems":true},{"default":1,"description":"**参数解释:**\n分页查询时,返回第几页数据\n**约束限制:**\n不涉及\n**取值范围:**\npage参数的实际有效范围取决于总数据量和pagesize的取值,不能大于总页数\n**默认取值:**\n1","in":"query","name":"page","required":false,"type":"integer"},{"default":1000,"description":"**参数解释:**\n分页查询时,每页包含的结果条数\n**约束限制:**\n不涉及\n**取值范围:**\n[0, 总数据量]\n**默认取值:**\n1000","in":"query","name":"pagesize","required":false,"type":"integer"}],"responses":{"200":{"description":"**参数解释:**\nOK\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","examples":{"application/json":{"items":[{"geoip":"GD","id":"06f07f6c229141b9a4a78614751bb687","name":"demo","policyid":"2abeeecefb9840e6bf05efbd80d0fcd7","status":1,"timestamp":1636340038062,"white":1}],"total":1}},"schema":{"$ref":"#/definitions/ListGeoIpResponseBody"}},"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":"查询所有策略地理位置访问控制","tags":["策略规则管理"],"x-api-type":"open-api","x-hybridcloud":true,"x-is-registered":"Y","x-request-examples-description-1":"查询所有策略地理位置访问控制","x-request-examples-url-1":"GET https://{endpoint}/v1/{project_id}/waf/rule/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"}