Overview
You can call this API to modify the display name of an OceanBase cluster instance.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. 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 Cloud instance. | ob317v4uif**** |
| requestId | string | Yes | The request ID for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceName | string | Yes | The name of the OceanBase cluster. | Test API |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | object | The information about the cluster. |
| instanceName | string | The ID of the OceanBase Cloud instance. |
Examples
Request example
curl --digest -u '<your ak:sk>' \
--request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/instanceName?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--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": "Test API"
},
"requestId": "6541ad2c-****-****-816f-ea61e825f497",
"success": true
}