Updated on 2025-08-20 GMT+08:00

Modifying a Private Domain Name

Function

This API is used to modify a private domain name.

Constraints

This API is available to RDS for MySQL and RDS for PostgreSQL only.

URI

  • URI format

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

  • Parameter description
    Table 1 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 Parameters

Parameter

Mandatory

Type

Description

dns_name

Yes

String

Specifies the prefix of the new domain name.

The value contains 8 to 64 characters. Only uppercase letters, lowercase letters, and digits are allowed.

Example Request

Modify the private domain name of a DB Instance.

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/modify-dns

{
     "dns_name": "testModifyDnsNewName"
}

Response

  • Normal response
    Table 3 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"
    }

Status Code

Error Code

For details, see Error Codes.