Function

This API is used to modify a private domain name.

Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.

URI

URI format
PUT /v3/{project_id}/instances/{instance_id}/modify-dns

Parameter description

**Table 1** URI Parameters
Parameter	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID.
instance_id	Yes	Specifies the DB instance ID.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	The content type. The default value is application/json.
X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dns_name	Yes	String	Specifies the prefix of the new domain name. The value contains 8 to 63 characters. Only uppercase letters, lowercase letters, and digits are allowed.

Example Request

Modify the private domain name of a DB Instance.

PUT https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/modify-dns
{
     "dns_name": "testModifyDnsNewName"
}

Response

Normal response
Table 4 Response body parameters
Parameter

Type

Description

job_id

String

Indicates the ID of the task for modifying a private domain name.

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Indicates the ID of the task for modifying a private domain name.

Normal response

{
    "job_id": "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
}

Abnormal response
For details, see Abnormal Request Results.

Status Code

Normal
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Modifying a Private Domain Name

Function

URI

Request

Example Request

Response

Status Code

Error Code