查詢可恢復 OceanBase 租戶。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（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 |
返回參數
示例
正常返回示例
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 返回結構發生變更 | 查看變更詳情 |