Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Changing a DB Instance Name
Updated on 2024-06-07 GMT+08:00
View PDF
Share

Changing a DB Instance Name

Function

This API is used to change a DB instance name.

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

name

Yes

String

Specifies the DB instance name.

DB instances of the same type can have same names under the same tenant. Valid value:

  • RDS for MySQL: The DB instance name must be 4 to 64 bytes long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_).
  • RDS for PostgreSQL and RDS for SQL Server: The DB instance name must be 4 to 64 bytes long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).

Example Request

Change the name of a DB instance.

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/name

{
     "name": "Test_2345674"
}

Response

  • Normal response

    None

  • Example normal response

    None

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management