huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"BatchUpdateGeoipRulesRequestBody":{"allOf":[{"$ref":"#/definitions/PolicyRuleIdRequestBody"},{"example":{"description":"","geoip":"BJ|GD|FJ|HA|HK|JX|NX|SN|XZ|AB2","name":"zbx","white":2},"properties":{"geoip":{"description":"**参数解释:**\n地理位置,指定需要控制的地域(如省份、城市编码,多个用|分隔)\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"name":{"description":"**参数解释:**\n规则名称,标识地理位置访问控制规则的名称\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"status":{"description":"**参数解释:**\n规则状态,控制地理位置访问控制规则的启用/禁用(如1表示启用,0表示禁用)\n**约束限制:**\n不涉及\n**取值范围:**\n- 0\n- 1\n**默认取值:**\n不涉及","type":"integer"},"white":{"description":"**参数解释:**\n放行或者拦截,1表示放行指定地理位置,2表示拦截指定地理位置\n**约束限制:**\n不涉及\n**取值范围:**\n- 1\n- 2\n\n**默认取值:**\n不涉及","type":"integer"}},"type":"object"}],"description":"**参数解释:**\n批量更新地理位置封禁body,用于批量修改地理位置访问控制规则的配置\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","example":{"geoip":"SH|TJ","name":"s","policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}],"white":0},"required":["geoip","policy_rule_ids"],"type":"object"},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"PolicyRuleIdRequestBody":{"example":{"policy_rule_ids":[{"policy_id":"06d320bf525249d4840fc2b94eba4612","rule_ids":["a29c412353594920bfe1bf8a799f7b5a","3d36b2f3f482462390f882bfb7460ca7"]}]},"properties":{"policy_rule_ids":{"description":"**参数解释:**\n策略和规则id数组,关联防护策略与对应的规则集合\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"properties":{"policy_id":{"description":"**参数解释:**\n策略id,唯一标识一条防护策略.策略id从\"查询防护策略列表\"(ListPolicy)接口获取\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"rule_ids":{"description":"**参数解释:**\n规则id数组,包含当前防护策略下的单个规则id,通过ListGeoipRule接口获取规则id\n**约束限制:**\n单条规则ID\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","example":["a29c412353594920bfe1bf8a799f7b5a","3d36b2f3f482462390f882bfb7460ca7"],"items":{"type":"string"},"type":"array"}},"required":["policy_id","rule_ids"]},"type":"array"}},"required":["policy_rule_ids"],"type":"object"},"PolicyRuleIdResponseBody":{"example":{"policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}]},"properties":{"policy_rule_ids":{"description":"**参数解释:**\n策略和规则id数组,返回防护策略与对应规则的ID关联关系\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"properties":{"policy_id":{"description":"**参数解释:**\n策略id,唯一标识一条防护策略\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"rule_ids":{"description":"**参数解释:**\n规则id数组,返回当前防护策略下的多条规则ID\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"type":"string"},"type":"array"}}},"type":"array"}},"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":"5979f17aeb0345ceaca6941502343f62","info_version":"v1","method":"post","name":"BatchUpdateGeoipRules","parameters":{},"paths":{"/v1/{project_id}/waf/rule/geoip/batch-update":{"post":{"description":"批量修改地理位置访问控制规则","operationId":"BatchUpdateGeoipRules","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"},{"default":"","description":"**参数解释:**\n项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。\n**约束限制:**\n不涉及\n**取值范围:**\n只能由英文字母、数字组成,且长度为32个字符。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"description":"**参数解释:**\n批量修改地理位置访问控制规则body\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"body","name":"BatchUpdateGeoipRulesRequestBody","required":false,"schema":{"$ref":"#/definitions/BatchUpdateGeoipRulesRequestBody"}},{"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"}],"produces":["application/json"],"responses":{"200":{"description":"**参数解释:**\nOK\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","examples":{"application/json":{"policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}]}},"schema":{"$ref":"#/definitions/PolicyRuleIdResponseBody"}},"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-apidesigner":58,"x-is-registered":"Y","x-support-international":true,"x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"批量修改地理位置访问控制规则","tags":"策略规则管理","uri":null,"version":"2.0"}