DescribeRestorableTenants - 查询可恢复租户 - 云数据库 OceanBase （文档停止维护）

查询可恢复 OceanBase 租户。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
IsRemote	boolean	否	为兼容老版本，可以为空。	true
SetId	string	否	备份集 ID。	bak-xxxxx
RestoreMode	string	否	恢复方式。非必填，在 IsRemote=true 时，必填。	from_time_point
Method	string	否	备份类型。	native_logical
IsOnline	boolean	否	目标解析集群是否在线。说明为兼容旧版本时可以不填，不填时值为对 isRemote 取反。	true
RestoreObjectType	string	否	恢复对象类型。	tenant

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
TotalCount	integer	总数量。	6
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenants	array<object>	租户信息。
Data	object	租户的列表信息。
TenantName	string	租户名称。	sbtest1
Method	string	备份方式。枚举值： native_logical：库表逻辑备份：native_logical：库表逻辑备份。 physical：物理备份：physical：物理备份。 logical：逻辑备份（OB2276及以下）：logical：逻辑备份（OB2276及以下）。	logical
TenantId	string	租户 ID。	ob317v4uif****
TimeIntervalList	array<object>	租户可恢复时间区间信息列表。
TimeIntervalList	object	租户可恢复时间区间信息。
StartTime	string	可恢复的起始时间。	2023-01-20T16:00:00Z
EndTime	string	可恢复的结束时间。	2023-03-13T02:43:03Z
FromArchive	boolean	是否属于归档恢复。	true
StorageType	string	备份存储类型。枚举值： standard：标准存储：standard：标准存储。 archive：归档存储：archive：归档存储。	standard
ClusterId	string	集群 ID。	objnf3b2****
ObRpmVersion	string	OceanBase RPM 版本号。	3.2.3.1-2022080510****
ObVersion	string	OceanBase 大版本号。	3.2.3.1
SourceRegion	string	集群所属地域。	cn-hangzhou
TenantAlias	string	租户别名。	aaa
CpuNum	long	租户 CPU 规格。	1
MemoryNum	long	租户存储规格。	100
BackupBucketName	string	备份目录名。	backup
ObTenantId	string	租户 ID。	tvd43v****
ClusterName	string	集群名称。	testCluster
BackupSets	array<object>	备份集列表。
BackupSets	object	备份集信息。
Checkpoint	string	备份集的快照点。	2024-01-01'T'12:10:10.000'Z'
SetId	string	备份集 ID。	bak-xxxxx
BackupSetId	string	恢复所使用的全量备份集 ID。	bak-4n****gacpa8
TenantId	string	租户 ID	t5********
UsedDisk	long	租户磁盘大小。	50
UnitNum	long	租户节点数。	2
TenantMode	string	租户模式。	Oracle
TenantDataBackupRemainDays	integer	租户备份数据剩余有效天数	7

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-02	OpenAPI 返回结构发生变更	查看变更详情