Modifying a DB Instance Name
API Description
This API is used to modify a DB instance name.
Restrictions
The name of the DB instance that is being created or fails to be created cannot be modified.
URI
- URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
Name | Type | IN | Mandatory | Description |
---|---|---|---|---|
X-Auth-Token | string | header | Yes | User token |
project_id | string | path | Yes | Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. |
instance_id | string | path | Yes | Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. |
Requests
- Parameter description
Table 2 Parameter description Name
Type
Mandatory
Description
new_instance_name
String
Yes
New instance name.
The instance name can be the same as an existing name.
The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.
- Request example{"new_instance_name": "myNewName"}
Responses
- Response example{}
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
- API Description
- Restrictions
- URI
- Requests
- Responses
- Status Code
- Error Code