Help Center> GaussDB> API Reference> API> Managing DB Instances> 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}/mysql/v3/{project_id}/instances/{instance_id}/name

  • Example

    PUT https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/43e4feaab48f11e89039fa163ebaa7e4br01/name

  • Parameter description
    Table 1 Parameter description

    Name

    Type

    Mandatory

    Description

    project_id

    String

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    instance_id

    String

    No

    DB instance ID.

Request

Table 2 Parameter description

Name

Type

Mandatory

Description

name

String

Yes

DB instance name.

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

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).
  • Request example 
    {
  "name": "gaussdb-name"
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Task ID for changing a DB instance name.
  • Example normal response

    {

    "job_id": "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"

    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances