查询黑白名单规则列表
功能介绍
查询黑白名单规则列表
URI
GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，对应控制台用户名->我的凭证->项目列表->项目ID |
| policy_id | 是 | String | 防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id |
| page | 否 | Integer | 分页查询时，返回第几页数据。默认值为1，表示返回第1页数据。 缺省值：1 |
| pagesize | 否 | Integer | 分页查询时，每页包含多少条结果。范围1-100，默认值为10，表示每页包含10条结果。 缺省值：10 |
| name | 否 | String | 黑白名单规则名称 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| Content-Type | 是 | String | 内容类型 缺省值：application/json;charset=utf8 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 黑白名单规则条数 |
| items | Array of WhiteBlackIpResponseBody objects | 黑白名单规则列表信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 规则id |
| name | String | 黑白名单规则名称 |
| policyid | String | 策略id |
| timestamp | Long | 创建规则的时间戳（毫秒） |
| description | String | 规则描述 |
| status | Integer | 规则状态，0：关闭，1：开启 |
| addr | String | Ip/Ip段 |
| white | Integer | 防护动作：
|
| ip_group | Ip_group object | Ip地址组 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | Ip地址组id，在新增Ip地址组时系统自动生成的唯一标识 |
| name | String | Ip地址组名 |
| size | Long | Ip地址组中包含Ip/Ip段的数量 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码： 401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0 响应示例
状态码： 200
OK
{
"total" : 1,
"items" : [ {
"id" : "3c96caf769ca4f57814fcf4259ea89a1",
"policyid" : "4dddfd44fc89453e9fd9cd6bfdc39db2",
"name" : "hkhtest",
"timestamp" : 1650362891844,
"description" : "demo",
"status" : 1,
"addr" : "x.x.x.x",
"white" : 0
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | 请求失败 |
| 401 | token权限不足 |
| 500 | 服务器内部错误 |
错误码
请参见错误码。
