更新时间:2024-12-05 GMT+08:00

添加域名组

功能介绍

添加域名组

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/domain-set

表1 路径参数

参数

是否必选

参数类型

描述

project_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对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表4 请求Body参数

参数

是否必选

参数类型

描述

fw_instance_id

String

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

object_id

String

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

name

String

域名组名称

description

String

描述

domain_names

Array of DomainSetInfoDto objects

域名信息列表

domain_set_type

Integer

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

表5 DomainSetInfoDto

参数

是否必选

参数类型

描述

domain_name

String

域名

description

String

描述

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

data

DomainSetResponseData object

添加域名组返回data

表7 DomainSetResponseData

参数

参数类型

描述

id

String

域名组id

name

String

域名组名称

请求示例

向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为fde07429-2e02-45c0-a85f-4f1cacea24d2,域名组类型为应用域名组。

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

{
  "name" : "test",
  "domain_set_type" : 0,
  "description" : "",
  "domain_names" : [ {
    "domain_name" : "www.aaa.com",
    "description" : ""
  } ],
  "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
  "object_id" : "fde07429-2e02-45c0-a85f-4f1cacea24d2"
}

响应示例

状态码: 200

添加域名组返回值

{
  "data" : {
    "id" : "e43db369-a863-45ed-8850-58d6b571b1ab",
    "name" : "test"
  }
}

状态码

状态码

描述

200

添加域名组返回值

错误码

请参见错误码