【产品技术】Web应用服务规则解析篇：精准防护（上）

project_id

是

String

用户操作的项目ID。

policy_id

是

String

策略ID。

offset

否

Long

指定返回的页数，取值范围为：[0, 65535]，默认值为0。

limit

否

Long

指定查询返回每页记录的最大条数，取值范围为：(0, 50]，默认值为10。

total

Integer

该策略下设置的精准防护规则总数量。

items

表3

精准防护规则的对象列表。

id

String

精准防护规则的ID。

policy_id

String

防护策略ID。

name

String

精准防护规则的名称。

conditions

List of 表4

匹配条件列表。匹配条件必须同时满足。

action

表5

精准防护规则命中后操作对象。

time

Boolean

精准防护规则的生效时间。

• “false”：表示该规则立即生效。

• “true”：表示自定义生效时间。

start

Long

精准防护规则生效的起始时间。当time=true，才会返回该参数。

end

Long

精准防护规则生效的终止时间。当time=true，才会返回该参数。

priority

Integer

执行该规则的优先级，值越小，优先级越高，值相同时，规则创建时间早，优先级越高。取值范围：0到65535。

timestamp

Long

创建精准访问防护规则的时间。

category

String

条件类型。固定值path、user-agent、ip、params、cookie、referer、header。

index

String

• 当“category”为“cookie”时，index表示cookie name。

• 当“category”为“params”时，index表示param name。

• 当“category”为“header”时，index表示header中的选项。

logic

String

“contain”，“not_contain”“equal”,“not_equal”,“prefix”，“not_prefix”，“suffix”，“not_suffix”分别代表包含、不包含、等于、不等于、前缀为、前缀不为、后缀为、后缀不为。

当条件类型“category”为ip时，“logic”只能为“equal”或者“not_equal”。

contents

List

条件匹配的内容。

category

String

操作类型。

• “block”：拦截。

• “pass”：放行。

200

OK

客户端请求已处理成功。

project_id

是

String

用户操作的项目ID。

policy_id

是

String

策略ID。

name

是

String

自定义规则的名称。最大长度为256字符。只支持以数字、字母、下划线或中划线命名。

time

否

Boolean

精准防护规则生效时间。

• “false”：表示该规则立即生效。

• “true”：表示自定义生效时间。

start

否

Long

精准防护规则生效的起始时间。当time=true时，起始时间和终止时间必须有一个非空。

end

否

Long

精准防护规则生效的终止时间。当time=true时，起始时间和终止时间必须有一个非空。

conditions

是

List of 表3

匹配条件列表。

action

是

表4

精准防护规则命中后操作对象。

priority

否

Integer

执行该规则的优先级，值越小，优先级越高，值相同时，规则创建时间早，优先级越高。取值范围：0到65535。

category

是

String

条件类型。固定值path、user-agent、ip、params、cookie、referer、header。

index

否

String

• 当“category”为“cookie”时，index表示cookie name。

• 当“category”为“params”时，index表示param name。

• 当“category”为“header”时，index表示header中的选项。

logic

是

String

“contain”，“not_contain”“equal”,“not_equal”,“prefix”，“not_prefix”，“suffix”，“not_suffix”分别代表包含、不包含、等于、不等于、前缀为、前缀不为、后缀为、后缀不为。

当条件类型“category”为ip时，“logic”只能为“equal”或者“not_equal”。

contents

是

List

条件匹配的内容。目前该字段只接受一个值，不要写入多个参数。

category

是

String

操作类型。

• “block”：拦截。

• “pass”：放行。

id

String

精准防护规则的ID。

policy_id

String

精准防护规则的策略ID。

name

String

精准防护规则的名称。

conditions

List of 表6

精准防护规则的匹配条件列表。

action

表7

精准防护规则命中后操作对象。

priority

Integer

执行该规则的优先级，值越小，优先级越高，值相同时，规则创建时间早，优先级越高。取值范围：0到65535。

time

Boolean

精准防护规则的生效时间。

• “false”：表示该规则立即生效。

• “true”：表示自定义生效时间。

start

Long

精准防护规则生效的起始时间。

end

Long

精准防护规则生效的终止时间。

timestamp

Long

创建精准访问防护规则的时间。

category

String

条件类型。固定值path、user-agent、ip、params、cookie、referer、header。

index

String

• 当“category”为“cookie”时，index表示cookie name。

• 当“category”为“params”时，index表示param name。

• 当“category”为“header”时，index表示header中的选项。

logic

String

“contain”，“not_contain”“equal”,“not_equal”,“prefix”，“not_prefix”，“suffix”，“not_suffix”分别代表包含、不包含、等于、不等于、前缀为、前缀不为、后缀为、后缀不为。

当条件类型“category”为ip时，“logic”只能为“equal”或者“not_equal”。

contents

List

条件匹配的内容。

category

String

操作类型。

• “block”：拦截。

• “pass”：放行。

200

OK

客户端请求已处理成功。