Description
You can call this operation to start backup scheduling for a cluster.
Call description
Prerequisites
You have passed the authentication for the OceanBase Cloud Platform (OCP) application service.
Request path
POST /api/v2/ob/clusters/{id}/backup/config/backupStrategy/startSchedule
Request parameters
Path parameters:
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | - | The ID of the cluster. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Object | The information of BackupCommonResponse. For more information, see Data structure of BackupCommonResponse. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Data structure of BackupCommonResponse
| Parameter | Type | Description |
|---|---|---|
| obBackupTaskType | String | The type of the task. |
| backupObjectOpsResultList | Array | The operation result set of the operation object. |
Examples
Sample request
POST /api/v2/ob/clusters/1000002/backup/config/backupStrategy/startSchedule
Sample response
{
"data": {
"backupObjectOpsResultList": [
{
"beSuccessful": true,
"obBackupObjectList": [
{
"backupDimension": "CLUSTER",
"clusterId": 1000002
}
]
}
],
"obBackupTaskType": "START_BACKUP_SCHEDULE"
},
"duration": 44,
"server": "d21b8dbaea",
"status": 200,
"successful": true,
"timestamp": "2024-09-10T10:05:56.665+08:00",
"traceId": "cd1ddb0b2db8f465"
}
