huawei-cloud-api-definitions-WAF 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"IpGroupBody":{"description":"ip地址组明细","properties":{"description":{"description":"地址组描述","type":"string"},"id":{"description":"地址组id","type":"string"},"ips":{"description":"地址组ip(以逗号分隔的ip或ip段)","type":"string"},"name":{"description":"地址组名称","type":"string"},"rules":{"description":"ip地址组绑定的规则列表","items":{"$ref":"#/definitions/RuleInfo"},"type":"array"},"share_info":{"$ref":"#/definitions/ShareInfo","description":"共享信息"},"size":{"description":"地址组长度","type":"integer"}}},"ListIpGroupResponseBody":{"properties":{"cloudTotal":{"description":"该用户总的Ip地址组数量,包含本地与共享地址组","type":"integer"},"items":{"description":"地址组信息列表","items":{"$ref":"#/definitions/IpGroupBody"},"type":"array"},"total":{"description":"该用户当前企业项目下Ip地址组数量,只包含本地地址组","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"},"RuleInfo":{"description":"使用该Ip地址相关的规则信息","properties":{"policy_id":{"description":"策略id","type":"string"},"policy_name":{"description":"策略名称","type":"string"},"rule_id":{"description":"规则id","type":"string"},"rule_name":{"description":"规则名称","type":"string"}}},"ShareInfo":{"description":"共享信息","properties":{"accept_count":{"description":"接受用户数","format":"int32","type":"integer"},"process_status":{"description":"处理状态","format":"int32","type":"integer"},"share_count":{"description":"共享用户数","format":"int32","type":"integer"}}}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"8f775d14aaf0465c8319158b43dd9bd6","info_version":"v1","method":"get","name":"ListIpGroup","parameters":{},"paths":{"/v1/{project_id}/waf/ip-groups":{"get":{"description":"查询地址组列表","operationId":"ListIpGroup","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"},{"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":1,"description":"页码,默认值为1","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"每页的条数,单页条数限制100,默认值为10","in":"query","name":"pagesize","required":false,"type":"integer"},{"description":"ip地址组名称,支持模糊查询","in":"query","name":"name","required":false,"type":"string"},{"description":"ip地址或ip段,传入该参数将查询包含传入的ip地址或ip段的地址组","in":"query","name":"ip","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"请求成功","examples":{"application/json":{"items":[{"description":"","id":"c36e896b18ee486a81026fce8e69fb1a","ips":"xx.xx.xx.xx","name":"sfddf","rules":[],"share_info":{"accept_count":0,"process_status":0,"share_count":0}}],"total":1}},"schema":{"$ref":"#/definitions/ListIpGroupResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"查询地址组列表","tags":["地址组管理"],"x-constraint":"中东-阿布扎比暂不支持该功能。","x-is-registered":"Y","x-request-examples-description-1":"查询项目id为project_id的地址组列表","x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/ip-groups?enterprise_project_id=0","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"}