このオペレーションを呼び出すと、OceanBase クラスターのバックアップ セットの情報をクエリできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
oceanbase:DescribeDataBackupSet |
none |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
OceanBase クラスターのインスタンス ID。 |
ob317v4uif**** |
| Status |
string |
任意 |
クエリするバックアップセットのステータス。 |
DONE |
| BackupObjectType |
string |
任意 |
クエリするバックアップセットのオブジェクトタイプ。 |
tenant |
| StartTime |
string |
任意 |
バックアップの開始時刻。形式は yyyy-MM-ddTHH:mm:ssZ (UTC 時刻) です。 |
2022-12-27T16:00:00Z |
| EndTime |
string |
任意 |
バックアップの終了時刻。 |
2023-01-06T15:59:59Z |
| PageNumber |
integer |
任意 |
ページネーションクエリのページ番号。 |
1 |
| PageSize |
integer |
任意 |
各ページに返す行数。
|
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
リクエストの戻り値です。 |
||
| TotalCount |
integer |
合計件数です。 |
2 |
| RequestId |
string |
リクエストの ID です。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Data |
array<object> |
返却されるデータです。 |
|
|
array<object> |
バックアップセットの詳細です。 |
||
| EndTime |
string |
バックアップの終了時刻です。 |
2023-04-13T03:38:10Z |
| Status |
string |
バックアップセットのステータスです。 |
RUNNING |
| Type |
string |
バックアップタイプです。 |
manual |
| StartTime |
string |
バックアップの開始時刻です。 |
2020-05-22T17:04:18 |
| DataSize |
integer |
バックアップセットのサイズです。 |
31457280 |
| Policy |
string |
バックアップ戦略です。 |
automated |
| SetId |
string |
バックアップセットの ID です。 |
imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70 |
| Method |
string |
バックアップ方法です。 |
logical |
| Checkpoint |
string |
チェックポイントです。 |
2023-05-15T07:11:08Z |
| DataVersion |
integer |
データバージョンです。 |
1678847020352 |
| BackupObjectType |
string |
バックアップオブジェクトタイプです。 |
cluster |
| BackupObjects |
array<object> |
バックアップオブジェクトです。 |
|
|
array<object> |
バックアップオブジェクトの詳細です。 |
||
| ClusterName |
string |
クラスター名です。 |
test-****way |
| TenantName |
string |
テナント名です。 |
ob2mr3oae0**** |
| DatabaseTablesList |
array<object> |
バックアップセット内のデータベースとテーブルです。 |
|
|
object |
バックアップセット内のデータベースとテーブルの詳細です。 |
||
| Database |
string |
データベース名です。 |
sms_pre |
| Tables |
array |
テーブルです。 |
|
|
string |
テーブルの詳細です。 |
{'Tables': []} |
|
| BackupResults |
array<object> |
バックアップ結果です。 |
|
|
array<object> |
バックアップ結果の詳細です。 |
||
| ClusterName |
string |
クラスター名です。 |
container-opa-****-02 |
| TenantName |
string |
テナント名です。 |
ob2mr3oae0**** |
| TableBackupResults |
array<object> |
テーブルのバックアップ結果です。 |
|
|
object |
テーブルのバックアップ結果の詳細です。 |
||
| Database |
string |
データベース名です。 |
order_ce****_online |
| Table |
string |
テーブル名です。 |
tr_sale_order_**** |
| Status |
string |
バックアップのステータスです。 |
RUNNING |
| Message |
string |
エラーの説明です。 |
Create tag success |
| DownloadTaskStatus |
string |
対象のバックアップセットに対応するダウンロードタスクのステータスです。 |
not_exist |
| DownloadTaskId |
integer |
対象のバックアップセットに対応するダウンロードタスクの ID です。 |
100***012 |
| Validity |
string |
有効性です。空の場合があります。 |
VALID |
| Progress |
string |
バックアップの進捗です。 |
52 |
| StorageClass |
string |
バックアップセットのタイプです。有効な値：
|
standard |
例
成功レスポンス
JSONJSON
{
"TotalCount": 2,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": [
{
"EndTime": "2023-04-13T03:38:10Z",
"Status": "RUNNING",
"Type": "manual",
"StartTime": "2020-05-22T17:04:18",
"DataSize": 31457280,
"Policy": "automated",
"SetId": "imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70",
"Method": "logical",
"Checkpoint": "2023-05-15T07:11:08Z",
"DataVersion": 1678847020352,
"BackupObjectType": "cluster",
"BackupObjects": [
{
"ClusterName": "test-****way",
"TenantName": "ob2mr3oae0****",
"DatabaseTablesList": [
{
"Database": "sms_pre",
"Tables": [
"{'Tables': []}"
]
}
]
}
],
"BackupResults": [
{
"ClusterName": "container-opa-****-02",
"TenantName": "ob2mr3oae0****\n",
"TableBackupResults": [
{
"Database": "order_ce****_online",
"Table": "tr_sale_order_****",
"Status": "RUNNING",
"Message": "Create tag success"
}
]
}
],
"DownloadTaskStatus": "not_exist",
"DownloadTaskId": 0,
"Validity": "VALID",
"Progress": "52",
"StorageClass": "standard"
}
]
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。