DescribeRestorableTenants - 查詢可恢複租戶 - ApsaraDB for OceanBase (Deprecated)

查詢可恢複 OceanBase 租戶。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeRestorableTenants

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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>	租戶資訊。
	array<object>	租戶的列表資訊。
TenantName	string	租戶名稱。	sbtest1
Method	string	備份方式。枚舉值： native_logical：庫表邏輯備份 : native_logical：庫表邏輯備份 physical：物理備份 : physical：物理備份 logical：邏輯備份（OB2276及以下） : logical：邏輯備份（OB2276 及以下）	logical
TenantId	string	租戶 ID。	ob317v4uif****
TimeIntervalList	array<object>	租戶可恢復區間資訊列表。
	object	租戶可恢復區間資訊。
StartTime	string	可恢複的起始時間。	2023-01-20T16:00:00Z
EndTime	string	可恢複的結束時間。	2023-03-13T02:43:03Z
FromArchive	boolean	是否屬于歸檔恢複。	true
StorageType	string	備份儲存類型。枚舉值： standard：標準儲存 : standard：標準儲存 archive：Archive Storage : archive：Archive Storage	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	integer	租戶 CPU 規格。	1
MemoryNum	integer	租戶儲存規格。	100
BackupBucketName	string	備份目錄名。	backup
ObTenantId	string	租戶 ID。	tvd43v****
ClusterName	string	叢集名稱。	testCluster
BackupSets	array<object>	備份組列表。
	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	integer	租戶磁碟大小。	50
UnitNum	integer	租戶節點數。	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
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。