Overview
You can call this API to start an OceanBase cluster instance.
Notice
After you call the StartCluster API, the instance will be billed again. For more information, see Instance billing.
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}/startCluster
Request parameters
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| None |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| None |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| success | boolean | Indicates whether the request was successful. | true/false |
| requestId | String | trace | dc302d76-66b5-48d8-ab53-a035******** (64-bit) |
Examples
Request example
curl --digest -u 'ak:sk'
--request PUT
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/startCluster
-H 'X-Ob-Project-Id: <Project ID>'
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
Here is a response example when the request is successful:
{
"success" : true,
"requestId": "xxxxxx"
}
Here is a response example when the request failed:
{
"errorCode":"IllegalOperation.Resource",
"errorMessage":"The current resource state does not allow this operation.",
"requestId":"xxxxxxx",
"success":false
}