Help Center> Relational Database Service> API Reference> API v3 (Recommended)> DB Instance Management> Changing a DB Instance Name
View PDF

Changing a DB Instance Name

Function

This API is used to change a DB instance name.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name

  • Example

    https://rds.cn-north-1.myhuaweicloud.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/name

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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

  • Parameter description
    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.

    The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
  • Request example 
    {
     "name": "Test_2345674"
}

Response

  • Normal response

    None

  • Example normal response

    None

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management