Updated on 2026-09-22 GMT+08:00

Editing the Name of an Instance

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

This API supports the following instances:

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

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:rename	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:rename	-

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition New instance name. Constraints The value cannot contain other special characters. Range 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 (_). Default Value N/A

Status code: 204

No response parameters

Changing the instance name to myNewName

PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name

{
  "name" : "myNewName"
}

None

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Instances