文档首页/ 云防火墙 CFW/ API参考/ API/ IPS白名单管理/ 查询IPS白名单列表详情
更新时间:2025-08-28 GMT+08:00
分享

查询IPS白名单列表详情

功能介绍

查询IPS白名单列表详情

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/cfw/{fw_instance_id}/ips/whitelist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

source_address

String

参数解释

白名单源地址

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

dest_address

String

参数解释

目的地址

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

name

String

参数解释

白名单名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

limit

Integer

参数解释

每页大小

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

offset

Integer

参数解释

偏移量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

ListIpsWhiteListsVO object

参数解释

IPS白名单响应体

取值范围

不涉及

表4 ListIpsWhiteListsVO

参数

参数类型

描述

limit

Integer

参数解释

每页数量

取值范围

不涉及

offset

Integer

参数解释

偏移量

取值范围

不涉及

total

Long

参数解释

总数

取值范围

不涉及

records

Array of IpsWhiteListVO objects

参数解释

IPS白名单列表

取值范围

不涉及

表5 IpsWhiteListVO

参数

参数类型

描述

source_address

String

参数解释

白名单源地址

取值范围

不涉及

dest_address

String

参数解释

目的地址

取值范围

不涉及

name

String

参数解释

白名单名称

取值范围

不涉及

list_id

String

参数解释

IPS白名单ID

取值范围

不涉及

effective_scopes

Array of strings

参数解释

生效范围:NAT EIP VPC HCS场景中还有VGW信息

取值范围

不涉及

ips_id

String

参数解释

生效范围:IPS规则ID,all代表所有IPS

取值范围

不涉及

ip_version

Integer

参数解释

IP类型

取值范围

4:表示IP类型为IPv4

6:表示IP类型为IPv6

description

String

参数解释

白名单描述

取值范围

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为eefb11b22d5944f2aa067954516df1cf,防火墙实例ID为175572ed-67e8-4837-9776-e2e07080ea45的IPS白名单列表

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/cfw/175572ed-67e8-4837-9776-e2e07080ea45/ips/whitelist?limit=1024&offset=0

响应示例

状态码:200

返回值

{
  "data" : {
    "limit" : 1024,
    "offset" : 0,
    "total" : 2,
    "records" : [ {
      "source_address" : "0.0.0.0/0",
      "dest_address" : "0.0.0.0/0",
      "name" : "test-001",
      "list_id" : "76fad07b-8304-486f-b802-943be05a3122",
      "effective_scopes" : [ "EIP" ],
      "ip_version" : 4
    }, {
      "source_address" : "8.8.8.0/32",
      "dest_address" : "8.8.8.0/32",
      "name" : "test-002",
      "list_id" : "4bf99009-e595-4cd4-bde1-e88c18861ec5",
      "effective_scopes" : [ "EIP" ],
      "ip_version" : 4
    } ]
  }
}

状态码

状态码

描述

200

返回值

400

Bad Request

错误码

请参见错误码

相关文档