Overview
Queries the backup strategy configuration of a specified OceanBase Cloud instance. The response includes the backup cycle, retention period, whether incremental backup, cross-region backup, and archive backup are enabled, and the sparse backup strategy. You can use this API to view the current backup strategy for subsequent adjustment or management.
API details
Constraints
The caller must have an AccessKey to access the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey Secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/backup/strategy
Request parameters
Path
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| Action | String | Yes | API action. Set the value to DescribeBackupStrategy. |
DescribeBackupStrategy |
| requestId | String | Yes | Request ID used for tracking. | d04eabba**** |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Business data. | None |
| cost | Number | Time consumed. | 1.0 |
| server | String | Server address, typically the IP address of an OBServer node. | 10.0.0.10 |
| requestId | String | Request ID. | d04eabba**** |
| totalCount | Number | Total number of records. | 100.0 |
| extra | Object | Extended information. | {} |
Fields of the data object
Name |
Type |
Description |
Example value |
|---|---|---|---|
| scheduleTime | String | Scheduling time. | 2026-02-25T15:40:43+00:00 |
| instanceId | String | OceanBase cluster ID. | obcluster-***** |
| backupModel | Object | None. | None |
| timeList | Array | List of backup or scheduling times. | None |
| lastDayOfMonth | Boolean | Whether this is the last day of the month. | true |
| backupDataType | String | Backup data type. | NORMAL |
| launchIncBackup | Boolean | Whether incremental backup is enabled. | true |
| launchExpirationCleanup | Boolean | Whether expired backup cleanup is enabled. | true |
| cleanupScheduleTime | String | Cleanup task scheduling time. | 2026-02-25T15:40:43+00:00 |
| dataMaintainDays | Integer | Data backup retention period in days. | 30 |
| nextBackupTime | String | Expected time of the next data backup. | 2026-02-25T15:40:43+00:00 |
| offsite | String | Whether cross-region backup is enabled. | OFF |
| crossRegionFlag | Boolean | Whether cross-region backup is enabled. | true |
| crossBorder | Boolean | Whether the backup is cross-border. | true |
| retainMode | String | Retention mode. | DAYS |
| remoteBackupRegion | String | Cross-region backup region. | cn-hangzhou |
| localBackupRegion | String | Local backup region. | cn-hangzhou |
| remoteBackupStrategy | Object | Cross-region backup strategy. | None |
| remoteBackupStrategy.backupScheduleMode | String | Backup schedule mode, such as weekly or monthly. | WEEK |
| remoteBackupStrategy.timeList | Array | List of backup or scheduling times. | ["2026-02-25 15:40:43+00:00", "2026-02-25 15:41:43+00:00"] |
| remoteBackupStrategy.backupTimesInMonth | String | Number of backups per month. | 2026-02-25T15:40:43+00:00 |
| remoteBackupStrategy.dataMaintainDays | Integer | Data backup retention period in days. | 30 |
| archiveFlag | Boolean | Whether archive backup is enabled. | true |
| archiveBackupStrategy | Object | Local archive backup strategy. | None |
| archiveBackupStrategy.backupScheduleMode | String | Backup schedule mode, such as weekly or monthly. | WEEK |
| archiveBackupStrategy.timeList | Array | List of backup or scheduling times. | None |
| archiveBackupStrategy.backupTimesInMonth | String | Number of backups per month. | 2026-02-25T15:40:43+00:00 |
| archiveBackupStrategy.dataMaintainDays | Integer | Data backup retention period in days. | 30 |
| remoteArchiveFlag | Boolean | Whether cross-region archive backup is enabled. | true |
| remoteArchiveBackupStrategy | Object | Cross-region archive backup strategy. | None |
| remoteArchiveBackupStrategy.backupScheduleMode | String | Backup schedule mode, such as weekly or monthly. | WEEK |
| remoteArchiveBackupStrategy.timeList | Array | List of backup or scheduling times. | None |
| remoteArchiveBackupStrategy.backupTimesInMonth | String | Number of backups per month. | 2026-02-25T15:40:43+00:00 |
| remoteArchiveBackupStrategy.dataMaintainDays | Integer | Data backup retention period in days. | 30 |
| sparseBackupFlag | Boolean | Whether sparse backup is enabled. | true |
| sparseBackupStrategies | Array | List of sparse backup strategies. | [{"id": "resource-123456"}] |
| backupMode | String | Backup mode, such as physical backup or logical backup. | physical |
| backupStorageConfig | String | Backup storage configuration. | 200 |
| tenantIds | Array | List of tenant IDs. | ["t4louaeei****"] |
| tenantScopeInfos | Array | List of tenants to which the backup strategy applies. | [{"tenantId": "t4louaeei****", "tenantName": "pay_core"}] |
Elements in data.sparseBackupStrategies[]
Name |
Type |
Description |
Example value |
|---|---|---|---|
| backupMaintainMatchRule | Object | Matching rules of the sparse backup retention strategy. | None |
| backupMaintainMatchRule.backupScheduleMode | Object | None. | None |
| backupMaintainMatchRule.weeks | Array | Weekly schedule: 1 to 7. | [1, 3, 5] |
| backupMaintainMatchRule.days | Array | Monthly schedule: day 1 to 31. | [1, 15] |
| backupMaintainMatchRule.month | Integer | Yearly schedule: month 1 to 12. | 1 |
| backupMaintainStrategy | Object | Sparse backup retention strategy. | None |
| backupMaintainStrategy.backupMaintainMode | Object | None. | None |
| backupMaintainStrategy.maintainDay | Integer | Retention period. This value is invalid for permanent retention. | 1 |
| backupMaintainStrategy.reserveLogBackup | Boolean | Whether log backups are retained. | true |
Elements in data.tenantIds[]
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.tenantIds[] | String | List of tenant IDs. | None |
Elements in data.tenantScopeInfos[]
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tenantId | String | Tenant ID. | t4louaeei**** |
| tenantName | String | Tenant name. | xxxxxx |
| tenantMode | String | Tenant mode, such as MySQL or Oracle. | xxxxxx |
Elements in data.timeList[]
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.timeList[] | Integer | List of backup or scheduling times. | None |
Examples
Request example
curl -X GET 'https://api.example.com/api/v2/instances/{instanceId}/backup/strategy?requestId=d04eabba****' \
-H 'Authorization: Bearer <your_access_token>'
Response example
JSON format
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"scheduleTime": "2026-02-25T15:40:43+00:00",
"instanceId": "obcluster-*****",
"backupModel": "xxxxxx",
"timeList": [],
"lastDayOfMonth": true,
"backupDataType": "NORMAL",
"launchIncBackup": true,
"launchExpirationCleanup": true,
"cleanupScheduleTime": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30,
"nextBackupTime": "2026-02-25T15:40:43+00:00",
"offsite": "OFF",
"crossRegionFlag": true,
"crossBorder": true,
"retainMode": "DAYS",
"remoteBackupRegion": "cn-hangzhou",
"localBackupRegion": "cn-hangzhou",
"remoteBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [
"2026-02-25 15:40:43+00:00",
"2026-02-25 15:41:43+00:00"
],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"archiveFlag": true,
"archiveBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"remoteArchiveFlag": true,
"remoteArchiveBackupStrategy": {
"backupScheduleMode": "WEEK",
"timeList": [],
"backupTimesInMonth": "2026-02-25T15:40:43+00:00",
"dataMaintainDays": 30
},
"sparseBackupFlag": true,
"sparseBackupStrategies": [
{
"id": "resource-123456",
"backupMaintainMatchRule": {
"backupScheduleMode": "xxxxxx",
"weeks": [
1,
3,
5
],
"days": [
1,
15
],
"month": 1
},
"backupMaintainStrategy": {
"backupMaintainMode": "xxxxxx",
"maintainDay": 1,
"reserveLogBackup": true
}
}
],
"backupMode": "physical",
"backupStorageConfig": "200",
"tenantIds": [
"t4louaeei****"
],
"tenantScopeInfos": [
{
"tenantId": "t4louaeei****",
"tenantName": "xxxxxx",
"tenantMode": "xxxxxx"
}
]
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}