Updated on 2026-03-16 GMT+08:00

Changing the Private Domain Name of a Proxy Instance

Function

This API is used to change the private domain name of a proxy instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_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
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

Request Parameters

**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 parameters
Parameter	Mandatory	Type	Description
new_dns_name	Yes	String	Definition New domain name. Constraints N/A Range N/A Default Value N/A
vpc_id	Yes	String	Definition VPC ID. To obtain this value, use either of the following methods: Method 1: Log in to the VPC console and view the VPC ID in the VPC details. Method 2: Query the VPC ID through the VPC API. For details, see . Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 202

**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.

Example Request

Changing the private domain name of a proxy instance

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/dns

{
  "new_dns_name" : "dns_name",
  "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0"
}

Example Response

Status code: 202

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy