查询所有策略CC规则

projectid

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

policyids

否

String

参数解释：

域名id。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。

约束限制：

不涉及

取值范围：

• 0：代表default企业项目

• all_granted_eps：代表所有企业项目

• 其它企业项目ID：长度为36个字符

默认取值：

0

page

否

Integer

参数解释：

分页查询的起始位置，表示从第几条记录开始返回（从1开始计数）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

1

pagesize

否

Integer

参数解释：

分页查询时，每页包含多少条结果。

约束限制：

不涉及

默认取值：

1000

X-Auth-Token

否

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

否

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8

total

Integer

Number of rules in the policy

items

Array of CcrulesListInfo objects

Array of Cc rules

name

String

参数解释：

规则名称

取值范围：

不涉及

id

String

参数解释：

规则id

取值范围：

不涉及

policyid

String

参数解释：

防护策略id

取值范围：

不涉及

url

String

参数解释：

mode值为0时，该参数有返回值。规则应用的URL链接，不包含域名。

取值范围：

不涉及

prefix

Boolean

参数解释：

路径是否为前缀模式，当防护url以*结束，则为前缀模式。当mode值为0时，该参数有返回值。

取值范围：

不涉及

mode

Integer

参数解释：

cc规则防护模式，对应console上的mode，现在只支持创建高级cc规则防护模式。

取值范围：

• 0：标准，只支持对域名的防护路径做限制。

• 1：高级，支持对路径、IP、Cookie、Header、Params字段做限制。

status

Integer

参数解释：

规则状态

取值范围：

• 0：关闭

• 1：开启

conditions

Array of CcCondition objects

参数解释：

cc规则防护规则限速条件，当cc防护规则为高级模式（mode参数值为1）时，该参数必填。

取值范围：

不涉及

action

action object

请求次数限制到达后采取的防护动作

tag_type

String

参数解释：

限速模式

取值范围：

• ip：IP限速，根据IP区分单个Web访问者。

• cookie：用户限速，根据Cookie键值区分单个Web访问者。

• header：用户限速，根据Header区分单个Web访问者。

• other：根据Referer（自定义请求访问的来源）字段区分单个Web访问者。

• policy: 策略限速

• domain: 域名限速

• url: url限速

tag_index

String

参数解释：

用户标识，当限速模式为用户限速(cookie或header)时，需要传该参数。

取值范围：

• 选择cookie时，设置cookie字段名，即用户需要根据网站实际情况配置唯一可识别Web访问者的cookie中的某属性变量名。用户标识的cookie，不支持正则，必须完全匹配。例如：如果网站使用cookie中的某个字段name唯一标识用户，那么可以选取name字段来区分Web访问者。

• 选择header时，设置需要防护的自定义HTTP首部，即用户需要根据网站实际情况配置可识别Web访问者的HTTP首部。

tag_condition

tag_condition object

用户标识，当限速模式为other时，需要传该参数。根据Referer（自定义请求访问的来源）字段区分单个Web访问者

limit_num

Integer

参数解释：

限制频率

取值范围：

范围为1~2147483647，单位为次。

limit_period

Integer

参数解释：

限速周期

取值范围：

范围1~3600，单位为秒。

unlock_num

Integer

参数解释：

放行频率。只有当防护动作类型为dynamic_block时，才需要传该参数。

取值范围：

范围为0~2147483647，单位为次。

lock_time

Integer

参数解释：

阻断时间。当“防护动作”选择“阻断”时，可设置阻断后恢复正常访问页面的时间。

取值范围：

范围为0~65535，单位为秒。

domain_aggregation

Boolean

参数解释：

是否开启域名聚合统计

取值范围：

不涉及

region_aggregation

Boolean

参数解释：

是否开启全局计数

取值范围：

不涉及

description

String

参数解释：

规则描述

取值范围：

不涉及

total_num

Integer

参数解释：

该参数为预留参数，用于后续功能扩展，当前请用户忽略该参数。

取值范围：

不涉及

unaggregation

Boolean

参数解释：

该参数为预留参数，用于后续功能扩展，当前请用户忽略该参数。

取值范围：

不涉及

aging_time

Integer

参数解释：

规则老化时间，该参数为预留参数，用于后续功能扩展，当前请用户忽略该参数。

取值范围：

不涉及

producer

Integer

参数解释：

规则创建对象，该参数为预留参数，用于后续功能扩展，当前请用户忽略该参数。

取值范围：

不涉及

timestamp

Long

参数解释：

创建规则时间戳

取值范围：

13位毫秒时间戳

category

String

参数解释：

字段类型

取值范围：

• url

• ip

• ipv6

• params

• cookie

• header

logic_operation

String

参数解释：

条件列表匹配逻辑

取值范围：

• 如果字段类型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。

• 如果字段类型category是ip或者ipv6，匹配逻辑可以为： equal、not_equal、equal_any或者not_equal_all。

• 如果字段类型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。

contents

Array of strings

参数解释：

条件列表逻辑匹配内容。当logic_operation参数不以any或者all结尾时，需要传该参数。

取值范围：

不涉及

value_list_id

String

参数解释：

引用表id。当logic_operation参数以any或者all结尾时，需要传该参数。此外，引用表类型要与category类型保持一致。

取值范围：

不涉及

index

String

参数解释：

子字段

取值范围：

当字段类型（category）选择“params”、“cookie”、“header”时，请根据实际需求配置子字段且该参数必填。

category

String

参数解释：

动作类型

取值范围：

• captcha：人机验证，阻断后用户需要输入正确的验证码，恢复正确的访问页面。

• block：阻断。

• log: 仅记录

• dynamic_block: 上一个限速周期内，请求频率超过“限速频率”将被阻断，那么在下一个限速周期内，请求频率超过“放行频率”将被阻断。注：只有当cc防护规则模式为高级模式时才支持设置dynamic_block防护动作。

detail

detail object

参数解释：

阻断页面信息。当防护动作（category）选择阻断（block）或者动态阻断（dynamic_block）时，需要设置返回的阻断页面。

• 如果需要返回的阻断页面为系统默认的阻断页面，不需要传该参数。

• 如果用户想防护自定义的阻断页面，可以通过此参数设置。

取值范围：

不涉及

response

response object

阻断页面

content_type

String

参数解释：

内容类型，值可为“application/json”、“text/html”、“text/xml”。

取值范围：

• application/json

• text/html

• text/xml

content

String

参数解释：

阻断页面内容

取值范围：

不涉及

category

String

参数解释：

用户标识字段，其值固定为referer。

取值范围：

• referer

contents

Array of strings

参数解释：

用户标识字段内容

取值范围：

不涉及

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

200

参数解释：

OK

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

400

参数解释：

请求失败

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

401

参数解释：

token权限不足

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

500

参数解释：

服务器内部错误

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及