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

添加域名列表

功能介绍

添加域名列表

URI

POST /v1/{project_id}/domain-set/domains/{set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

set_id

是

String

域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

fw_instance_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型，只有application/json的值是适用的
表4 请求Body参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。

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（.表示各对象之间层级的区分）获得

domain_names

是

Array of DomainSetInfoDto objects

域名列表
表5 DomainSetInfoDto

参数

是否必选

参数类型

描述

domain_name

是

String

域名，如www.test.com

description

否

String

域名描述

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

data

DomainSetResponseData object

域名组返回值数据
表7 DomainSetResponseData

参数

参数类型

描述

id

String

域名组id

name

String

域名组名称

请求示例

给项目id为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名，防火墙id为546af3f8-88e9-47f2-a205-2346d7090925，防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b，域名组id为78719348-6d79-477e-acec-676a29842ab2，域名为www.bnm.com和www.vbc.com

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

{
  "domain_names" : [ {
    "description" : "",
    "domain_name" : "www.bnm.com"
  }, {
    "description" : "",
    "domain_name" : "www.vbc.com"
  } ],
  "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
  "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}

响应示例

状态码：200

添加域名返回值

{
  "data" : {
    "id" : "78719348-6d79-477e-acec-676a29842ab2",
    "name" : "test26"
  }
}

状态码

状态码

描述

200

添加域名返回值

错误码

请参见错误码。