Adding a Domain Name Group

Function

This API is used to add a domain name group.

URI

POST /v1/{project_id}/domain-set

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by referring to Obtaining a User Token.
Content-Type	Yes	String	Content type. It can only be set to application/json.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
fw_instance_id	Yes	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.
object_id	Yes	String	Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).
name	Yes	String	Domain name group name.
description	No	String	Domain name group description.
domain_names	Yes	Array of DomainSetInfoDto objects	Domain name information list.
domain_set_type	No	Integer	Domain name group typ: 0 (application domain name group), 1 (network domain name group).

**Table 5** DomainSetInfoDto
Parameter	Mandatory	Type	Description
domain_name	Yes	String	Domain name, for example, www.test.com.
description	No	String	Domain name description.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
data	DomainSetResponseData object	Returned data for adding a domain name group.

**Table 7** DomainSetResponseData
Parameter	Type	Description
id	String	Domain name group ID.
name	String	Domain name group name.

Example Requests

Add an application domain name group whose name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 to the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429.

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

{
  "name" : "test",
  "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

Return value for adding a domain name group.

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

Status Codes

Status Code	Description
200	Return value for adding a domain name group.

Error Codes

See Error Codes.

Parent topic:Domain Name Resolution and Domain Name Group Management

Previous topic: Domain Name Resolution and Domain Name Group Management

Next topic: Deleting a Domain Name Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot