{"base_path":"/","components":null,"consumes":"","definitions":{"CcCondition":{"properties":{"category":{"description":"字段类型","enum":["url","ip","ipv6","params","cookie","header"],"type":"string"},"contents":{"description":"条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时,需要传该参数。","items":{"type":"string"},"type":"array"},"index":{"description":"子字段,当字段类型(category)选择“params”、“cookie”、“header”时,请根据实际需求配置子字段且该参数必填。","type":"string"},"logic_operation":{"description":"条件列表匹配逻辑。 \n - 如果字段类型category是url, 匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、 not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal或者len_not_equal \n - 如果字段类型category是ip或者ipv6,匹配逻辑可以为: equal、not_equal、equal_any或者not_equal_all \n - 如果字段类型category是params、cookie或者header, 匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 contain_any、 not_contain_all、 equal_any、not_equal_all、 equal_any、 not_equal_all、 prefix_any、 not_prefix_all、 suffix_any、 not_suffix_all、 len_greater、 len_less、len_equal、len_not_equal、、num_greater、num_less、num_equal、num_not_equal、exist或者not_exist","type":"string"},"value_list_id":{"description":"引用表id。当logic_operation参数以any或者all结尾时,需要传该参数。此外,引用表类型要与category类型保持一致。","type":"string"}},"required":["category","logic_operation"]},"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"},"ShowCcRuleResponsebody":{"properties":{"action":{"description":"请求次数限制到达后采取的防护动作","properties":{"category":{"description":"动作类型:\n - captcha:人机验证,阻断后用户需要输入正确的验证码,恢复正确的访问页面。\n -block:阻断。 \n - log: 仅记录 \n - dynamic_block: 上一个限速周期内,请求频率超过“限速频率”将被阻断,那么在下一个限速周期内,请求频率超过“放行频率”将被阻断。注:只有当cc防护规则模式为高级模式时才支持设置dynamic_block防护动作。","enum":["captcha","block","log","dynamic_block"],"type":"string"},"detail":{"description":"阻断页面信息。当防护动作(category)选择阻断(block)或者动态阻断(dynamic_block)时,需要设置返回的阻断页面。\n - 如果需要返回的阻断页面为系统默认的阻断页面,不需要传该参数。\n - 如果用户想防护自定义的阻断页面,可以通过此参数设置","properties":{"response":{"description":"阻断页面","properties":{"content":{"description":"阻断页面内容","type":"string"},"content_type":{"description":"内容类型,值可为“application/json”、“text/html”、“text/xml”。","enum":["application/json","text/html","text/xml"],"type":"string"}},"type":"object"}}}},"required":["category"]},"aging_time":{"description":"规则老化时间,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数","type":"integer"},"conditions":{"description":"cc规则防护规则限速条件,当cc防护规则为高级模式(mode参数值为1)时,该参数必填。","items":{"$ref":"#/definitions/CcCondition"},"type":"array"},"description":{"description":"规则描述","type":"string"},"domain_aggregation":{"description":"是否开启域名聚合统计。","type":"boolean"},"id":{"description":"Rule ID.","type":"string"},"limit_num":{"description":"限制频率,单位为次,范围为1~2147483647","type":"integer"},"limit_period":{"description":"限速周期,单位为秒,范围1~3600","type":"integer"},"lock_time":{"description":"阻断时间,单位为秒,范围为0~65535。当“防护动作”选择“阻断”时,可设置阻断后恢复正常访问页面的时间。","type":"integer"},"mode":{"description":"cc规则防护模式,对应console上的mode,现在只支持创建高级cc规则防护模式。 \n - 0:标准,只支持对域名的防护路径做限制。\n - 1:高级,支持对路径、IP、Cookie、Header、Params字段做限制。","enum":[0,1],"type":"integer"},"name":{"description":"规则名称","type":"string"},"policyid":{"description":"Policy ID.","type":"string"},"prefix":{"description":"路径是否为前缀模式,当防护url以*结束,则为前缀模式。","type":"boolean"},"producer":{"description":"规则创建对象,该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数","type":"integer"},"region_aggregation":{"description":"是否开启全局计数。","type":"boolean"},"status":{"description":"规则状态,0:关闭,1:开启","type":"integer"},"tag_condition":{"description":"用户标识,当限速模式为other时,需要传该参数。根据Referer(自定义请求访问的来源)字段区分单个Web访问者","properties":{"category":{"description":"用户标识字段,其值固定为referer","type":"string"},"contents":{"description":"用户标识字段内容","items":{"type":"string"},"type":"array"}}},"tag_index":{"description":"用户标识,当限速模式为用户限速(cookie或header)时,需要传该参数。 \n - 选择cookie时,设置cookie字段名,即用户需要根据网站实际情况配置唯一可识别Web访问者的cookie中的某属性变量名。用户标识的cookie,不支持正则,必须完全匹配。例如:如果网站使用cookie中的某个字段name唯一标识用户,那么可以选取name字段来区分Web访问者。 \n - 选择header时,设置需要防护的自定义HTTP首部,即用户需要根据网站实际情况配置可识别Web访问者的HTTP首部。","type":"string"},"tag_type":{"description":"限速模式: \n - ip:IP限速,根据IP区分单个Web访问者。 \n - cookie:用户限速,根据Cookie键值区分单个Web访问者。 \n - header:用户限速,根据Header区分单个Web访问者。 \n - other:根据Referer(自定义请求访问的来源)字段区分单个Web访问者。 \n - policy: 策略限速 \n - domain: 域名限速 \n - url: url限速","enum":["ip","cookie","header","other","policy","domain","url"],"type":"string"},"timestamp":{"description":"创建规则时间戳","format":"int64","type":"integer"},"total_num":{"description":"该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数","type":"integer"},"unaggregation":{"description":"该参数为预留参数,用于后续功能扩展,当前请用户忽略该参数","type":"boolean"},"unlock_num":{"description":"放行频率,单位为次,范围为0~2147483647。只有当防护动作类型为dynamic_block时,才需要传该参数。","type":"integer"},"url":{"description":"当mode值为0时,该参数有返回值。规则应用的URL链接,不包含域名。","type":"string"}},"type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"72deea5a4d7b4db19693fbcedddcbb4d","info_version":"v1","method":"get","name":"ShowCcRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}":{"get":{"description":"根据Id查询cc防护规则","operationId":"ShowCcRule","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"},{"description":"策略id(策略id从查询防护策略列表接口获取)","in":"path","name":"policy_id","required":true,"type":"string"},{"default":"","description":"ID of the cc rule. It can be obtained by calling the **ListCcRules** API.","in":"path","name":"rule_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Request succeeded.","examples":{"application/json":{"action":{"category":"captcha"},"aging_time":0,"conditions":[{"category":"url","contents":["/url"],"logic_operation":"contain"}],"description":"","domain_aggregation":false,"id":"f88c5eabff9b4ff9ba6e7dd8e38128ba","limit_num":10,"limit_period":60,"lock_time":0,"mode":1,"name":"test55","policyid":"d471eef691684f1c8d7784532fd8f4bd","producer":1,"region_aggregation":false,"status":1,"tag_type":"ip","timestamp":1678873040603,"total_num":0,"unaggregation":false}},"schema":{"$ref":"#/definitions/ShowCcRuleResponsebody"}},"400":{"description":"Request failed.","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"The token does not have required permissions.","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"Internal server error.","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"根据Id查询cc防护规则","tags":["策略规则管理"],"x-is-registered":"Y","x-request-examples-description-1":"查询项目id为project_id,防护策略id为policy_id,规则id为rule_id的cc防护规则。","x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}?","x-support-international":true,"x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"根据Id查询cc防护规则","tags":"策略规则管理","uri":null,"version":"2.0"}