Overview
You can call this API to rename an OceanBase cluster.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/instanceName
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceName | String | Yes | The name of the OceanBase cluster. | TestAPI |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Object | The cluster information. | |
| instanceName | String | The name of the OceanBase cluster. | TestAPI |
Examples
Request example
curl --digest -u 'ak:sk' \
--request PUT \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/instanceName
-H 'X-Ob-Project-Id: <Project ID>'
--data \ '{"instanceName":"nameAAA"}'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
JSON format
{
"data":{
"instanceName":"TestAPI"
},
"requestId":"6541ad2c-****-****-816f-ea61e825f497",
"success":true
}