Database Backup Service (DBS) の復元ジョブのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dbs:DescribeRestoreTaskList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BackupPlanId |
string |
任意 |
バックアップスケジュールの ID。 説明
BackupPlanId または RestoreTaskId のいずれかを指定する必要があります。 |
dbs1hvb0wwwXXXXX |
| RestoreTaskId |
string |
任意 |
復元ジョブの ID。複数の ID を指定できます。コンマ (,) で区切ります。CreateRestoreTask 操作を呼び出してこのパラメーターを取得できます。 説明
RestoreTaskId または BackupPlanId のいずれかを指定する必要があります。両方を指定すると、エラーが返されます。 |
s102h7rf5anq |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。有効値：1～100。 説明
デフォルト値は 30 です。 |
30 |
| PageNum |
integer |
任意 |
ページ番号。値は 0 以上の整数である必要があります。デフォルト値は 0 です。 |
1 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 |
ETnLKlblzczshOTUbOCzxxxxxxx |
| StartTimestamp |
integer |
任意 |
バックアップの開始時刻。 |
1570701361528 |
| EndTimestamp |
integer |
任意 |
バックアップの終了時刻。 |
1570701361528 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されたパラメーターの詳細。 |
||
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| PageNum |
integer |
ページ番号。 |
1 |
| RequestId |
string |
リクエスト ID。 |
9C397502-B4F2-4E22-AD97-C81F0049F3F3 |
| ErrCode |
string |
エラーコード。 |
Param.NotFound |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| ErrMessage |
string |
エラーメッセージ。 |
The specified parameter %s value is not valid. |
| TotalPages |
integer |
総ページ数。 |
1 |
| TotalElements |
integer |
復元ジョブの総数。 |
1 |
| PageSize |
integer |
現在のページのエントリ数。 |
30 |
| Items |
object |
||
| RestoreTaskDetail |
array<object> |
復元ジョブの詳細。 |
|
|
object |
|||
| RestoreStatus |
string |
復元ジョブのステータス。有効な値：
|
running |
| FullStruAfterRestoreProgress |
integer |
復元後の完全な構造タスクの進行状況。 |
100 |
| CrossRoleName |
string |
クロスアカウントバックアップに使用される Resource Access Management (RAM) ロールの名前。 |
test123 |
| RestoreDir |
string |
復元パス。 |
100.X.X.10:33204 |
| CrossAliyunId |
string |
クロスアカウントバックアップに使用される Alibaba Cloud アカウントの UID。 |
2xxx7778xxxxxxxxxx |
| RestoreObjects |
string |
復元するオブジェクト。 |
[ { \"DBName\":\"test\" } ] |
| BackupPlanId |
string |
バックアップスケジュールの ID。 |
dbs1hvb0wXXXX |
| DestinationEndpointRegion |
string |
データベースのリージョン。 |
cn-hangzhou |
| RestoreTaskCreateTime |
integer |
復元ジョブが作成された時刻。これは UNIX タイムスタンプです。単位：ミリ秒。例：1554560477000。 |
1554560477000 |
| DestinationEndpointUserName |
string |
データベースアカウント。 |
test |
| RestoreTaskFinishTime |
integer |
復元ジョブが完了した時刻。これは UNIX タイムスタンプです。単位：ミリ秒。例：1554560477000。 |
1554560477000 |
| DestinationEndpointIpPort |
string |
データベースエンドポイント。 |
100.X.X.10:33204 |
| DestinationEndpointDatabaseName |
string |
データベース名。 |
test |
| DestinationEndpointInstanceType |
string |
データベースの場所。有効な値：
|
RDS |
| DestinationEndpointOracleSID |
string |
Oracle システム ID (SID)。 |
test |
| FullStruforeRestoreProgress |
integer |
復元前の完全な構造タスクの進行状況。 |
0 |
| ErrMessage |
string |
エラーメッセージ。 |
NULL |
| RestoreTaskId |
string |
復元ジョブの ID。 |
s1XXXXXX |
| FullDataRestoreProgress |
integer |
完全なデータ復元の進行状況。 |
100 |
| ContinuousRestoreProgress |
integer |
増分ログ復元の進行状況。 |
100 |
| DestinationEndpointInstanceID |
string |
データベースインスタンスの ID。 |
rm-bp1p8c2947XXX |
| BackupSetId |
string |
復元に使用される完全バックアップセットの ID。 |
1ibh2f5uXXX |
| BackupGatewayId |
integer |
バックアップゲートウェイの ID。 |
324234332 |
| RestoreTaskName |
string |
復元ジョブの名前。 |
test |
| RestoreTime |
integer |
データベースが復元される時刻。これは UNIX タイムスタンプです。単位：ミリ秒。例：1554560477000。 |
1554560477000 |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"TotalPages": 1,
"TotalElements": 1,
"PageSize": 30,
"Items": {
"RestoreTaskDetail": [
{
"RestoreStatus": "running",
"FullStruAfterRestoreProgress": 100,
"CrossRoleName": "test123",
"RestoreDir": "100.X.X.10:33204",
"CrossAliyunId": "2xxx7778xxxxxxxxxx",
"RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
"BackupPlanId": "dbs1hvb0wXXXX",
"DestinationEndpointRegion": "cn-hangzhou",
"RestoreTaskCreateTime": 1554560477000,
"DestinationEndpointUserName": "test",
"RestoreTaskFinishTime": 1554560477000,
"DestinationEndpointIpPort": "100.X.X.10:33204",
"DestinationEndpointDatabaseName": "test",
"DestinationEndpointInstanceType": "RDS",
"DestinationEndpointOracleSID": "test",
"FullStruforeRestoreProgress": 0,
"ErrMessage": "NULL",
"RestoreTaskId": "s1XXXXXX",
"FullDataRestoreProgress": 100,
"ContinuousRestoreProgress": 100,
"DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
"BackupSetId": "1ibh2f5uXXX",
"BackupGatewayId": 324234332,
"RestoreTaskName": "test",
"RestoreTime": 1554560477000
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。