更新时间:2022-02-22 GMT+08:00

查询隐私屏蔽规则列表

功能介绍

查询某个策略下所有的隐私屏蔽规则列表。

URI

  • URI格式

    GET /v1/{project_id}/waf/policy/{policy_id}/privacy?offset={offset}&limit={limit}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    用户操作的项目ID。

    policy_id

    String

    策略ID。

    offset

    Long

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

    limit

    Long

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

请求消息

请求参数

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

total

Integer

规则总数量。

items

表3

隐私屏蔽规则对象列表。

表3 items

名称

参数类型

说明

id

String

隐私屏蔽规则ID。

policy_id

String

策略ID。

path

String

隐私屏蔽规则应用的URL(默认完全匹配)。

category

String

屏蔽字段,取值范围是:params,header。

index

String

屏蔽字段名。

timestamp

Long

创建隐私屏蔽规则的时间。

示例

如下以查询隐私屏蔽规则列表,返回记录条数为“2”为例。

响应样例
{
  "total": 2,
  "items": [{
      "id": "e1c0e55865544d1f8c95cf71df108c6b",
      "policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
      "path": "/login",
      "category": "params",
      "index": "password",
      "timestamp": 123243414132
    }, {
      "id": "d947d31c3e794b70a25e5e2057997f8e",
      "policy_id": "yuc0e55865544d1f8c95cf71df108c89",
      "path": "/register",
      "category": "header",
      "index": "x-auth-token",
      "timestamp": 1343243243123
    }
  ]
}

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码,请参见状态码