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

查询域名组列表

功能介绍

查询域名组列表

URI

GET /v1/{project_id}/domain-sets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

fw_instance_id

是

String

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

limit

是

Integer

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

offset

是

Integer

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

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

关键字，可使用域名组名称或描述

domain_set_type

否

Integer

域名组类型，0表示应用域名组，1表示网络域名组

config_status

否

Integer

配置状态，-1表示未配置态，0表示配置失败，1表示配置成功，2表示配置中，3表示正常，4表示配置异常

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

ListDomainsetsResponseData object

查询域名组列表返回值数据
表5 ListDomainsetsResponseData

参数

参数类型

描述

limit

Integer

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

offset

Integer

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

total

Integer

域名组总数

records

Array of DomainSetVo objects

域名组列表
表6 DomainSetVo

参数

参数类型

描述

set_id

String

域名组id

name

String

域名组名称

description

String

域名组描述

ref_count

Integer

域名组被规则引用次数

domain_set_type

Integer

域名组类型，0表示应用域名组，1表示网络域名组

config_status

Integer

配置状态，-1表示未配置态，0表示配置失败，1表示配置成功，2表示配置中，3表示正常，4表示配置异常

rules

Array of UseRuleVO objects

使用规则id列表
表7 UseRuleVO

参数

参数类型

描述

id

String

规则id

name

String

规则名称

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429下的防火墙 id为546af3f8-88e9-47f2-a205-2346d7090925下的域名组列表，防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b

响应示例

状态码：200

查询域名组列表返回值

{
  "data": {
    "limit": 50,
    "offset": 0,
    "records": [
      {
        "config_status": 3,
        "description": "",
        "domain_set_type": 0,
        "name": "ccdd",
        "ref_count": 0,
        “rules"：[],
        "set_id": "e43db369-a863-45ed-8850-58d6b571b1ab"
      }
    ],
    "total": 1
  }
}

状态码

状态码

描述

200

查询域名组列表返回值

错误码

请参见错误码。