文档首页/ 云防火墙 CFW/ API参考（安卡拉区域）/ API/ 域名解析及域名组管理/ 获取域名组下域名列表
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取域名组下域名列表

功能介绍

获取域名组下域名列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/domain-set/domains/{domain_set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

domain_set_id

是

String

域名组id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

是

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

limit

是

Integer

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

offset

是

Integer

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

domain_name

否

String

域名名称

object_Id

否

String

互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象id。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

ListDomainResponseData object

查询域名返回值data
表5 ListDomainResponseData

参数

参数类型

描述

limit

Integer

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

offset

Integer

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

project_id

String

租户项目id

records

Array of DomainInfo objects

域名信息列表

set_id

String

域名组id

total

Integer

总数
表6 DomainInfo

参数

参数类型

描述

domain_address_id

String

域名地址id

domain_name

String

域名

description

String

描述

dns_ips

Array of strings

域名服务器列表

请求示例

查询项目id为14181c1245cf4fd786824efe1e2b9388下的域名列表，域名组id为78719348-6d79-477e-acec-676a29842ab2，防火墙id为546af3f8-88e9-47f2-a205-2346d7090925。

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=200&offset=0

响应示例

状态码： 200

查询域名返回值

{
  "data" : {
    "limit" : 200,
    "offset" : 0,
    "project_id" : "14181c1245cf4fd786824efe1e2b9388",
    "records" : [ {
      "description" : "",
      "domain_address_id" : "6718279e-9761-4623-a48d-b16957b19e1b",
      "domain_name" : "www.test.com"
    } ],
    "set_id" : "78719348-6d79-477e-acec-676a29842ab2",
    "total" : 1
  }
}

状态码

状态码

描述

200

查询域名返回值

错误码

请参见错误码。