Overview
You can call this API to query the list of tenants that can be restored.
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
GET /api/v2/instances/{instanceId}/backup/restore/tenants
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. |
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| tenantId | String | No | The ID of the tenant. |
| backupSetId | String | No | The ID of the backup set. |
| restoreObjectType | String | No | The type of the restore object. Valid values:
|
| fromRemote | Boolean | No | Specifies whether to restore from a remote backup. |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Array | The list of tenants that can be restored. | - |
| backupSetRestoreSummaries | Array | The list of backup set restore summaries. | - |
| cpuNum | Integer | The number of CPU cores. | 1 |
| memoryNum | Integer | The size of memory, in GB. | 16 |
| obVersion | String | The version of OceanBase Database. | 3.2.4.8 |
| status | String | The status of the tenant. | ONLINE |
| tenantId | String | The ID of the tenant. | txxx |
| tenantMode | String | The mode of the tenant. | MySQL |
| tenantName | String | The name of the tenant. | mysql_tenant |
| timeIntervalList | Array | The list of time intervals during which the tenant can be restored. | - |
| endTime | String | The latest time point during which the tenant can be restored. | 2025-03-24T03:48:43Z |
| startTime | String | The earliest time point during which the tenant can be restored. | 2025-03-19T20:56:24Z |
| storageType | String | The storage type. | standard |
| unitNum | Integer | The number of units. | 1 |
| usedDisk | Integer | The size of the used disk space, in bytes. | 154306565146 |
| requestId | String | The ID of the request. | fb778279-44aa-4c6c-bacc-c096bbeffde0 |
| success | Boolean | Indicates whether the request is successful. | true |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/restore/tenants' \
-G -d 'instanceId=xxx' -d 'tenantId=xxx' -d 'backupSetId=xxx' -d 'restoreObjectType=xxx' -d 'fromRemote=xxx'
Response example
JSON format
{
"data":[
{
"backupSetRestoreSummaries":[],
"cpuNum":1,
"memoryNum":4,
"obVersion":"3.2.4.8",
"status":"ONLINE",
"tenantId":"txxx",
"tenantMode":"MySQL",
"tenantName":"mysql_tenant",
"timeIntervalList":[
{
"endTime":"2026-01-12T10:42:26Z",
"startTime":"2026-01-12T06:11:10Z",
"storageType":"standard"
},
{
"endTime":"2026-01-12T12:06:26Z",
"startTime":"2026-01-12T12:00:12Z",
"storageType":"standard"
},
{
"endTime":"2026-01-14T03:34:22Z",
"startTime":"2026-01-14T02:05:20Z",
"storageType":"standard"
}
],
"unitNum":1,
"usedDisk":96468992
},
{
"backupSetRestoreSummaries":[],
"cpuNum":1,
"memoryNum":4,
"obVersion":"3.2.4.8",
"status":"ONLINE",
"tenantId":"t7eryoun5rl7k",
"tenantMode":"MySQL",
"tenantName":"zx_restore",
"timeIntervalList":[
{
"endTime":"2026-01-14T03:34:19Z",
"startTime":"2026-01-14T02:05:20Z",
"storageType":"standard"
}
],
"unitNum":1,
"usedDisk":88080384
},
],
"requestId":"dec235d2-6e7f-442e-84ac-ce5e22d03633",
"success":true
}