Add Domain Set

Function

This API is used to add domain set.

URI

POST /v1/{project_id}/domain-set

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	No	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
fw_instance_id	Yes	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.
object_id	Yes	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
name	Yes	String	name
description	No	String	description
domain_names	No	Array of DomainSetInfoDto objects	domain names
domain_set_type	Yes	Integer	Domain name group type. 0 means Application type and 1 means Network type.

**Table 5** DomainSetInfoDto
Parameter	Mandatory	Type	Description
domain_name	No	String	domain name
description	No	String	description

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
data	DomainSetResponseData object	Add Domain Set Response Data

**Table 7** DomainSetResponseData
Parameter	Type	Description
id	String	id
name	String	name

Example Requests

Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is 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"
}

Example Responses

Status code: 200

Add Domain Set Response

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

Status Codes

Status Code	Description
200	Add Domain Set Response

Error Codes

See Error Codes.

Parent topic: Domain Parse and Domain Set Management

16 KiB Raw Blame History