文档首页/云防火墙 CFW/API参考 (联盟区域) /API/地址组管理/查询地址组列表
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询地址组列表

功能介绍

查询地址组列表

URI

GET /v1/{project_id}/address-sets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

key_word

否

String

关键字，包括地址组名称或描述的一部分

limit

是

Integer

每页显示个数，范围为1-1024

offset

是

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

address

否

String

ip地址

address_type

否

Integer

地址Internet协议类型0 ipv4，1 ipv6

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

query_address_set_type

否

Integer

查询地址组类型，0表示自定义地址组，1表示预定义地址组，当address_set_type不为0时，query_address_set_type为1时才可以生效。

address_set_type

否

Integer

地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

data object

查询地址组列表返回数据

表5 data

参数

参数类型

描述

offset

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

limit

Integer

每页显示个数，范围为1-1024

total

Integer

地址组总数

records

Array of records objects

地址组列表

表6 records

参数

参数类型

描述

set_id

String

地址组id

ref_count

Integer

地址组被规则引用次数

description

String

描述信息

address_type

Integer

地址Internet协议类型0 ipv4，1 ipv6

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

address_set_type

Integer

地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为5c69cf330cda42369cbd726ee1bc5e76，防护对象id为8a41d6a5-f215-428a-a76c-dc923b5d599a的第一页的ip地址组信息

https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0

响应示例

状态码：200

查询地址组列表返回值

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "address_set_type" : 0,
      "object_id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16",
      "address_type" : 0,
      "description" : "",
      "name" : "test",
      "ref_count" : 0,
      "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b"
    } ],
    "total" : 1
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.0020016",
  "error_msg" : "实例状态错误"
}

状态码

状态码

描述

200

查询地址组列表返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：地址组管理