Applying for a Private Domain Name_Instance Management_APIs (Recommended)_API Reference

This API is used to apply for a private domain name. Before calling this API:

POST /v3/{project_id}/instances/{instance_id}/dns

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
dns_type	Yes	String	Definition Domain name type. Constraints N/A Range private: private domain name Default Value N/A

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Applying for a private domain name

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/af315b8e6aaa41799bd9a31f2de15abcin07/dns
{
  "dns_type" : "private"
}

Status code: 200

Success.

{
  "job_id" : "d5169969-e391-482a-9755-042b2d83ed17"
}

For details, see Status Codes.

For details, see Error Codes.

Applying for a Private Domain Name