Overview
You can call this API to stop an OceanBase cluster instance.
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}/stopCluster
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| None |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| None |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| success | Boolean | Indicates whether the request is successful. | true or false |
| requestId | String | The ID of the request. | 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}/stopCluster
-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.
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
}