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"}}},"ListPrivacyRuleResponseBody":{"properties":{"items":{"description":"规则详情数组","items":{"$ref":"#/definitions/PrivacyResponseBody"},"type":"array"},"total":{"description":"规则条数","type":"integer"}},"type":"object"},"PrivacyResponseBody":{"description":"隐私屏蔽响应体","properties":{"category":{"description":"屏蔽字段 \n - Params:请求参数 \n - Cookie:根据Cookie区分的Web访问者 \n - Header:自定义HTTP首部 \n - Form:表单参数","enum":["params","cookie","header","form"],"type":"string"},"description":{"description":"规则描述,可选参数,设置该规则的备注信息。","type":"string"},"id":{"description":"规则id","type":"string"},"index":{"description":"屏蔽字段名,根据“屏蔽字段”设置字段名,被屏蔽的字段将不会出现在日志中。","type":"string"},"policyid":{"description":"策略id","type":"string"},"status":{"description":"规则状态,0:关闭,1:开启","type":"integer"},"timestamp":{"description":"创建规则的时间,格式为13位毫秒时间戳","format":"int64","type":"integer"},"url":{"description":"隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/*,以\"*\"号结尾代表路径前缀","type":"string"}},"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":"52195c4ba7d04f7294b24b0eccec67c6","info_version":"v1","method":"get","name":"ListPrivacyRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/privacy":{"get":{"description":"查询隐私屏蔽防护规则列表","operationId":"ListPrivacyRule","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"},{"description":"防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id","in":"path","name":"policy_id","required":true,"type":"string"},{"description":"分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。","in":"query","name":"page","required":false,"type":"integer"},{"description":"分页查询时,每页包含多少条结果。范围1-100,默认值为10,表示每页包含10条结果。","in":"query","name":"pagesize","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"请求成功","examples":{"application/json":{"items":[{"category":"cookie","description":"demo","id":"97e4d35f375f4736a21cccfad77613eb","index":"demo","policyid":"38ff0cb9a10e4d5293c642bc0350fa6d","status":1,"timestamp":1650533191385,"url":"/demo"}],"total":1}},"schema":{"$ref":"#/definitions/ListPrivacyRuleResponseBody"}},"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-description-1":"查询项目id为project_id,防护策略id为policy_id的隐私屏蔽防护规则列表。","x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?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"}