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.

  • Before calling this API, obtain the required region and endpoint.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/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. Its value can be any of the following:

    The parameter must be 4 to 64 characters long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).

  • Request example

    PUT https://{Endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/name
    
    {
         "name": "Test_2345674"
    }
    

Response

Status Code

Error Code

For details, see Error Codes.