Adding a Domain Name

Function

This API is used to add a domain name.

URI

POST /v1/{project_id}/cae/domains

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
api_version	Yes	String	API version. Fixed value: v1. Enumerated value: v1
kind	Yes	String	API type. Fixed value: Domain. Enumerated value: Domain
metadata	Yes	CreateMetaDomain object	Request data.

**Table 4** CreateMetaDomain
Parameter	Mandatory	Type	Description
name	Yes	String	Domain name.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1. Enumerated value: v1
items	Array of DomainItem objects	Domain name list.
kind	String	API type. Fixed value: Domain.

**Table 6** DomainItem
Parameter	Type	Description
metadata	MetaDomain object	Response data.

**Table 7** MetaDomain
Parameter	Type	Description
id	String	Domain name ID.
name	String	Domain name.
created_at	String	Creation time.

Example Request

Add domain name example.cn.

POST https://{endpoint}/v1/{project_id}/cae/domains

{
  "api_version" : "v1",
  "kind" : "Domain",
  "metadata" : {
    "name" : "example.cn"
  }
}

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "Domain",
  "items" : [ {
    "metadata" : {
      "id" : "4475ba56-7669-4af8-8707-c9b1368c3f9c",
      "name" : "example.cn",
      "created_at" : "2022-12-30T08:33:35.140718Z"
    }
  } ]
}