Editing the Name of an Instance
Function
This API is used to edit the name of an instance.
Constraints
This API supports the following instance types:
- GeminiDB Cassandra
- GeminiDB Influx
- GeminiDB Redis
The name of the instance that is being created or fails to be created cannot be edited.
URI
PUT /v3/{project_id}/instances/{instance_id}/name
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | New instance name. The name: Must start with a letter and can include 4 to 64 characters. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). |
Response Parameters
Status code: 204
No response parameters
Example Request
- URI example
PUT https://gaussdb-nosql.eu-west-101.myhuaweicloud.eu/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name
- Changing the instance name to myNewName
{ "name" : "myNewName" }
Example Response
None
Status Codes
See Status Codes.
Error Codes
See Error Codes.
