DescribeRestorableTenants API Reference - ApsaraDB for OceanBase - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Queries information about restorable OceanBase Database tenants.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeRestorableTenants

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
IsRemote	boolean	No	This parameter is provided for compatibility with earlier versions and can be left empty.	true
SetId	string	No	The ID of the backup set.	bak-xxxxx
RestoreMode	string	No	The restore method. This parameter is required when `IsRemote` is set to `true`, and is optional otherwise.	from_time_point
Method	string	No	The backup method.	native_logical
IsOnline	boolean	No	Specifies whether the target cluster is online. Note This parameter is used for compatibility with earlier versions and can be left empty. When left empty, it specifies negation for the value of `isRemote`.	true
RestoreObjectType	string	No	The type of the restore object.	tenant

Response elements

Element	Type	Description	Example
	object	The return result of the request.
TotalCount	integer	The total number.	6
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenants	array<object>	The information about the tenants.
	array<object>	The list of tenant information.
TenantName	string	The name of the tenant.	sbtest1
Method	string	The backup method. Valid values: native_logical：库表逻辑备份 : physical：物理备份 : logical：逻辑备份（OB2276及以下） :	logical
TenantId	string	The ID of the tenant.	ob317v4uif****
TimeIntervalList	array<object>	The list of restorable periods of the tenant.
	object	Information about the restorable periods.
StartTime	string	The start time of the restorable period.	2023-01-20T16:00:00Z
EndTime	string	The end time of the restorable period.	2023-03-13T02:43:03Z
FromArchive	boolean	Indicates whether the restore is based on archiving.	true
StorageType	string	The storage type of backup data. Valid values: standard：标准存储 : archive：归档存储 :	standard
ClusterId	string	The ID of the cluster.	objnf3b2****
ObRpmVersion	string	The version of the OceanBase Database RPM package.	3.2.3.1-2022080510****
ObVersion	string	The major version of OceanBase Database.	3.2.3.1
SourceRegion	string	The region of the cluster.	cn-hangzhou
TenantAlias	string	The alias of the tenant.	aaa
CpuNum	integer	The number of CPU cores.	1
MemoryNum	integer	The size of memory for the tenant.	100
BackupBucketName	string	The name of the backup directory.	backup
ObTenantId	string	The ID of the tenant.	tvd43v****
ClusterName	string	The name of the cluster.	testCluster
BackupSets	array<object>	The list of backup sets.
	object	The information about the backupsets.
Checkpoint	string	The checkpoint of the backup set.	2024-01-01'T'12:10:10.000'Z'
SetId	string	The ID of the backup set.	bak-xxxxx
BackupSetId	string	The ID of the full backup set used for restore.	bak-4n****gacpa8
TenantId	string	The ID of the tenant.	t5********
UsedDisk	integer	The size of disk space for the tenant.	50
UnitNum	integer	The number of nodes of the tenant.	2
TenantMode	string	The mode of the tenant.	Oracle
TenantDataBackupRemainDays	integer	The remaining validity period, in days, of the backup data of the tenant.	7

Examples

Success response

JSON format

{
  "TotalCount": 6,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Tenants": [
    {
      "TenantName": "sbtest1",
      "Method": "logical",
      "TenantId": "ob317v4uif****",
      "TimeIntervalList": [
        {
          "StartTime": "2023-01-20T16:00:00Z",
          "EndTime": "2023-03-13T02:43:03Z",
          "FromArchive": true,
          "StorageType": "standard"
        }
      ],
      "ClusterId": "objnf3b2****",
      "ObRpmVersion": "3.2.3.1-2022080510****",
      "ObVersion": "3.2.3.1",
      "SourceRegion": "cn-hangzhou",
      "TenantAlias": "aaa",
      "CpuNum": 1,
      "MemoryNum": 100,
      "BackupBucketName": "backup",
      "ObTenantId": "tvd43v****",
      "ClusterName": "testCluster",
      "BackupSets": [
        {
          "Checkpoint": "2024-01-01'T'12:10:10.000'Z'",
          "SetId": "bak-xxxxx",
          "BackupSetId": "bak-4n****gacpa8",
          "TenantId": "t5********"
        }
      ],
      "UsedDisk": 50,
      "UnitNum": 2,
      "TenantMode": "Oracle",
      "TenantDataBackupRemainDays": 7
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.