Files

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>

2025-09-04 07:22:35 +00:00

8.9 KiB

Raw Blame History

Editing the Name of an Instance

Function

This API is used to edit the name of an instance.

Constraints

This API can be used for GeminiDB Cassandra instances.

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

URI

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

**Table 1** URI parameters
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

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. application/json is recommended.
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameter
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

None

Example Request

URI example

PUT https://{Endpoint}/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.

Parent topic: Instances

8.9 KiB Raw Blame History