Overview
You can call this API to query the list of tenants that can be restored in the specified OceanBase Cloud database instance and their associated backup sets.
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 |
|---|---|---|---|
| restoreType | String | No | The restore type. |
| openRequest | unknown | Yes | Specifies whether to enable the request. |
Header
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Ob-Project-Id | String | Yes | The ID of the project. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| 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. |
| memoryNum | Integer | The size of memory, in GB. |
| obVersion | String | The version of OceanBase Database. |
| status | String | The status of the tenant. |
| tenantId | String | The ID of the tenant. |
| tenantMode | String | The mode of the tenant. |
| tenantName | String | The name of the 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. |
| startTime | String | The earliest time point during which the tenant can be restored. |
| storageType | String | The storage type. |
| unitNum | Integer | The number of units. |
| usedDisk | Integer | The size of the used disk space, in bytes. |
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request is successful. |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/restore/tenants?restoreType={restoreType}&openRequest={openRequest}' \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}'
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
}