huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"BatchUpdateCustomRulesRequestBody":{"example":{"action":{"category":"block"},"conditions":[{"category":"header","contents":["demo"],"index":"demo","logic_operation":"contain"}],"description":"","name":"test","policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}],"priority":50,"time":false},"properties":{"action":{"$ref":"#/definitions/CustomAction"},"action_mode":{"description":"预留参数,可忽略。","type":"boolean"},"conditions":{"description":"匹配条件列表,匹配条件必须同时满足。","items":{"properties":{"category":{"description":"字段类型。可选值为:url、user-agent、ip、params、cookie、referer、header、request_line、method、reqeust","type":"string"},"contents":{"description":"条件匹配的内容","items":{"type":"string"},"type":"array"},"index":{"description":"子字段:\n - 字段类型为url、user-agent、ip、refer、request_line、method、reqeust时,不需要传index参数  \n - 字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段","type":"string"},"logic_operation":{"description":"条件匹配逻辑","type":"string"},"value_list_id":{"description":"引用表id。","type":"string"}}},"type":"array"},"description":{"description":"规则描述","type":"string"},"name":{"description":"规则名称","type":"string"},"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,您可以通过调用查询精准防护规则列表(ListCustomRules)获取规则id\n**约束限制:**\n单条规则ID\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["policy_id","rule_ids"]},"type":"array"},"priority":{"description":"执行该规则的优先级,值越小,优先级越高,值相同时,规则创建时间早,优先级越高。取值范围:0到65535。","type":"integer"},"producer":{"description":"规则创建对象,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数","type":"integer"},"start":{"description":"精准防护规则生效的起始时间戳(秒)。当time=true,才会返回该参数。","format":"int64","type":"integer"},"status":{"description":"**参数解释:**\n规则状态标识,用于指定规则的启用或关闭状态\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:关闭\n - 1:开启\n**默认取值:**\n不涉及","enum":[0,1],"type":"integer"},"terminal":{"description":"精准防护规则生效的终止时间戳(秒)。当time=true,才会返回该参数。","format":"int64","type":"integer"},"time":{"description":"精准防护规则生效时间: \n- false:表示该规则立即生效\n- true:表示自定义生效时间","type":"boolean"}},"required":["policy_rule_ids"],"type":"object"},"CustomAction":{"description":"精准防护规则命中后操作对象","properties":{"category":{"description":"操作类型。 \n - block:拦截\n - pass:放行 \n - log:仅记录","enum":["block","pass","log"],"type":"string"},"followed_action_id":{"description":"攻击惩罚规则id,只有当category参数值为block时才可配置该参数","type":"string"}},"required":["category"]},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"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":"04c54e3d28024232acf824afa0185df7","info_version":"v1","method":"post","name":"BatchUpdateCustomRules","parameters":{},"paths":{"/v1/{project_id}/waf/rule/custom/batch-update":{"post":{"description":"批量更新精准防护规则","operationId":"BatchUpdateCustomRules","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":"BatchUpdateCustomRuleRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchUpdateCustomRulesRequestBody"}},{"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-request-examples-1":{"action":{"category":"block"},"conditions":[{"category":"header","contents":["demo"],"index":"demo","logic_operation":"contain"}],"description":"","name":"test","policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}],"priority":50,"time":false},"x-request-examples-description-1":"批量更新精准防护规则","x-request-examples-text-1":{"action":{"category":"block"},"conditions":[{"category":"header","contents":["demo"],"index":"demo","logic_operation":"contain"}],"description":"","name":"test","policy_rule_ids":[{"policy_id":"4a34899ab17a4811a6da57742f69135a","rule_ids":["ed37d85a925d469bb01986d06291d15f"]}],"priority":50,"time":false},"x-request-examples-url-1":"POST https://{endpoint}/v1/{project_id}/waf/rule/custom/batch-update?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"}