Parse global backup information

Overview

This API is used to access the specified backup storage using the host managed by the current OCP, and parse the source cluster, source tenant, data backup point, log backup interval, and recoverable time interval from it.

A typical scenario is as follows: In the production environment, tenant backups are stored in OSS. The test environment has no association with the production environment's OCP or OceanBase clusters, but can access that OSS. The caller can use this API to parse backup information, select a restore point, and submit an offline tenant restore task.

API details

Constraints

• The caller must pass the authentication for the OCP application service and have the backup read permission.
• The caller must have read permission on the selected resolution host, and the resolution host must be able to access the specified backup storage.

Request path

POST /api/v2/backup/info

Request parameters

Query parameters

Body parameters

Data structure of ParseObBackupInfoParam

Data structure of ObBackupStorageBaseInfo

Data structure of object storage access credentials

When logStorageMode is INDEPENDENT, the following constraints also apply:

• Independent log storage only supports BACKUP_STORAGE_FILE or BACKUP_STORAGE_S3.
• The storage root directories for data backup and log backup must be different and not include each other.
• The logBackupStorageBaseInfo parameter must be specified. If you do not specify the logHostIdList parameter, OCP will reuse the hostIdList parameter.

Response parameters

Basic Data Structures

Data structure of ObClusterBackupInfo

Data structure of ObTenantBackupInfo

Data structure of ObRecoverableInfoAggregation

Data structure of ObRecoverableSectionItem

Examples

Request example

Parse backup information for the last seven days in OSS:

POST /api/v2/backup/info?timeScopeType=LATEST_SEVEN_DAYS

{
  "obBackupStorageBaseInfo": {
    "backupStorageType": "BACKUP_STORAGE_OSS",
    "storageUrl": "example-bucket/obbackup",
    "ossAccessKey": {
      "endpoint": "oss-cn-hangzhou.aliyuncs.com",
      "accessKeyId": "${ACCESS_KEY_ID}",
      "accessKeySecret": "${ACCESS_KEY_SECRET}"
    }
  },
  "hostIdList": [3001],
  "logStorageMode": "SAME_AS_DATA"
}

When using a file system or NFS, replace the storage part with:

{
  "backupStorageType": "BACKUP_STORAGE_FILE",
  "storageUrl": "/data/obbackup"
}

Response example

The following example shows only the main fields used in this process:

{
  "data": {
    "contents": [
      {
        "clusterName": "prod_cluster",
        "obClusterId": 1001,
        "clusterId": null,
        "online": false,
        "tenantBackupInfos": [
          {
            "clusterName": "prod_cluster",
            "obClusterId": 1001,
            "clusterId": null,
            "obTenantId": 1002,
            "tenantId": null,
            "tenantName": "tenant_a",
            "mode": "MYSQL",
            "online": false,
            "obRecoverableInfoAggregation": {
              "obQueryTimeScopeType": "LATEST_SEVEN_DAYS",
              "latestSevenDaysAggregation": {
                "obRecoverableSectionItems": [
                  {
                    "obRecoverableSectionItemType": "RECOVERABLE",
                    "backupMode": "PHYSICAL_BACKUP",
                    "realRecoverableTimeInterval": {
                      "startTime": "2026-09-02T10:00:00+08:00",
                      "endTime": "2026-09-09T10:00:00+08:00"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    ]
  },
  "duration": 1280,
  "server": "10.0.0.10",
  "status": 200,
  "successful": true,
  "timestamp": "2026-09-09T10:00:01.280+08:00",
  "traceId": "3cfec9a5180748ff"
}