huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"CreatePrivacyResponseBody":{"description":"创建隐私屏蔽响应体","properties":{"category":{"description":"**参数解释:**\n屏蔽字段\n**约束限制:**\n不涉及\n**取值范围:**\n - params: 请求参数\n - cookie: 根据Cookie区分的Web访问者\n - header: 自定义HTTP首部\n - form: 表单参数\n**默认取值:**\n不涉及","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":"**参数解释:**\n规则状态标识,用于指定规则的启用或关闭状态\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:关闭\n - 1:开启\n**默认取值:**\n不涉及","enum":[0,1],"type":"integer"},"timestamp":{"description":"创建规则的时间,格式为13位毫秒时间戳","format":"int64","type":"integer"},"url":{"description":"隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/\\*,以\"\\*\"号结尾代表路径前缀","type":"string"}},"type":"object"},"CreatePrivacyRuleRequestBody":{"properties":{"category":{"description":"**参数解释:**\n屏蔽字段\n**约束限制:**\n不涉及\n**取值范围:**\n - params: 请求参数\n - cookie: 根据Cookie区分的Web访问者\n - header: 自定义HTTP首部\n - form: 表单参数\n**默认取值:**\n不涉及","enum":["params","cookie","header","form"],"type":"string"},"description":{"description":"规则描述,可选参数,设置该规则的备注信息。","type":"string"},"index":{"description":"**参数解释:**\n屏蔽字段名,被屏蔽的字段将不会出现在日志中\n**约束限制:**\n长度不能超过2048字节\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"url":{"description":"**参数解释:**\n隐私屏蔽规则防护的url,需要填写标准的url格式,例如/admin/xxx或者/admin/\\*,以\"\\*\"结尾的路径前缀表示一个通配符,用于匹配该路径前缀下的所有子路径。例如,如果你有一个路径前缀/admin/,那么它将匹配所有以/admin/开头的URL路径。将url的参数设置为/admin/\\*,所有以/admin/开头的URL路径都会被该规则所覆盖\n**约束限制:**\n标准URL字符串或者URL前缀匹配字符串\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"}},"required":["url","category","index"],"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":"1d6cabc929c7412fafee72fc5e18d1ed","info_version":"v1","method":"post","name":"CreatePrivacyRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/privacy":{"post":{"description":"创建隐私屏蔽防护规则","operationId":"CreatePrivacyRule","parameters":[{"description":"**参数解释:**\n用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","maxLength":4096,"minLength":32,"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"},{"description":"**参数解释:**\n项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"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策略id,唯一标识一条防护策略,可从\"查询防护策略列表\"(ListPolicy)接口获取\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"path","name":"policy_id","required":true,"type":"string"},{"description":"创建隐私屏蔽规则请求体","in":"body","name":"CreatePrivacyRuleRequestBody","required":true,"schema":{"$ref":"#/definitions/CreatePrivacyRuleRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"请求成功","examples":{"application/json":{"category":"cookie","description":"demo","id":"97e4d35f375f4736a21cccfad77613eb","index":"demo","policyid":"38ff0cb9a10e4d5293c642bc0350fa6d","status":1,"timestamp":1650533191385,"url":"/demo"}},"schema":{"$ref":"#/definitions/CreatePrivacyResponseBody"}},"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":{"category":"cookie","description":"demo","index":"demo","url":"/demo"},"x-request-examples-description-1":"在项目id为project_id,防护策略id为policy_id的防护策略下创建隐私屏蔽防护规则,隐私屏蔽规则防护的url为“/demo”,屏蔽字段为Cookie,屏蔽字段名为“demo”,规则描述为“demo”。","x-request-examples-text-1":{"category":"cookie","description":"demo","index":"demo","url":"/demo"},"x-request-examples-url-1":"POST 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"}