doc-exports/docs/opengauss/api-ref/opengauss_api_0022.html

Changing a DB Instance Name

Function

This API is used to change an instance name. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

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

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	Yes	DB instance ID.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  name	Yes	String	DB instance name. Instances of the same type can have same names under the same tenant. The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).

Example Request

Changing a DB instance name

{
  "name": "instance-name"
}

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  job_id	String	Task ID for changing an instance name.

• Example normal response

  {
  	"job_id": "2b414788a6004883a02390e2eb0ea227"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management