復元可能な OceanBase データベーステナントの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
oceanbase:DescribeRestorableTenants |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
任意 |
対象クラスターがオンラインかどうかを指定します。 注 このパラメーターは旧バージョンとの互換性のために使用され、空のままにできます。空のままにした場合、このパラメーターの実効値は |
true |
| RestoreObjectType |
string |
任意 |
復元オブジェクトのタイプです。 |
tenant |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
リクエストの結果です。 |
||
| TotalCount |
integer |
総数です。 |
6 |
| RequestId |
string |
リクエスト ID です。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Tenants |
array<object> |
テナントに関する情報です。 |
|
|
array<object> |
テナント情報のリストです。 |
||
| TenantName |
string |
テナントの名前です。 |
sbtest1 |
| Method |
string |
バックアップ方法です。 列挙値:
|
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 |
| ClusterId |
string |
クラスターの ID です。 |
objnf3b2**** |
| ObRpmVersion |
string |
OceanBase Database RPM パッケージのバージョンです。 |
3.2.3.1-2022080510**** |
| ObVersion |
string |
OceanBase Database のメジャーバージョンです。 |
3.2.3.1 |
| SourceRegion |
string |
クラスターのリージョンです。 |
cn-hangzhou |
| TenantAlias |
string |
テナントのエイリアスです。 |
aaa |
| CpuNum |
integer |
CPU コアの数です。 |
1 |
| MemoryNum |
integer |
テナントのメモリサイズです。 |
100 |
| BackupBucketName |
string |
バックアップディレクトリの名前です。 |
backup |
| ObTenantId |
string |
OceanBase のテナント 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 |
例
成功レスポンス
JSONJSON
{
"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
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。