Modifying a DB Instance Name

Function

This API is used to modify a DB instance name.

Constraints

The name of the DB instance that is being created or fails to be created cannot be modified.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  instance_id	Yes	Specifies the DB instance ID.

Requests

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  new_instance_name	Yes	String	Specifies the DB instance name. The DB instance name of the same DB engine is unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).

• Request header

  PUT https://DDS endpoint/v3/{project_id}/instances/{instance_id}/modify-name

• Example request

  {
      "new_instance_name": "myNewName"
  }

Responses

• Response example

  {}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.