DescribeRestorableTenants - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

Queries information about restorable OceanBase Database tenants.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeRestorableTenants	get	All Resources ``	none	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. Enumeration Value: from_backup_set from_time_point	from_time_point
Method	string	No	The backup method. Enumeration Value: logical physical native_logical	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. Enumeration Value: cluster tenant database table serverless	tenant

Response parameters

Parameter	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.
Data	object	The list of tenant information.
TenantName	string	The name of the tenant.	sbtest1
Method	string	The backup method.	logical
TenantId	string	The ID of the tenant.	ob317v4uif****
TimeIntervalList	array<object>	The list of restorable periods of the tenant.
TimeIntervalList	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.	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	long	The number of CPU cores.	1
MemoryNum	long	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.
BackupSets	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	long	The size of disk space for the tenant.	50
UnitNum	long	The number of nodes of the tenant.	2
TenantMode	integer	The mode of the tenant.	Oracle
TenantDataBackupRemainDays	integer	The remaining validity period, in days, of the backup data of the tenant.	7

Examples

Sample success responses

JSONformat

{
  "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": 0,
      "TenantDataBackupRemainDays": 7
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-02	The response structure of the API has changed	View Change Details