Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Changing a Private Domain Name
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Changing a Private Domain Name

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 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 the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

dns_name

Yes

String

Prefix of the new domain name. Value:

The name can contain 8 to 63 characters. Only uppercase letters, lowercase letters, and digits are allowed.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID.

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.

Example Request

Changing a private domain name

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/af315b8e6aaa41799bd9a31f2de15abcin07/dns

{
  "dns_name" : "testmodifydnsname"
}

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management