指定された条件に一致する復元ジョブを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hbr:DescribeRestoreJobs2 |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
ページ番号。 ページは 1 から始まります。 デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
ページあたりのエントリ数。 有効値：1～99。 デフォルト値：10。 |
10 |
| RestoreType |
string |
任意 |
データソースのタイプ。 有効な値：
|
ECS_FILE |
| Filters |
array<object> |
任意 |
フィルター条件。 |
|
|
object |
任意 |
復元ジョブを照会するためのフィルター。 |
||
| Key |
string |
任意 |
フィルターキー。 有効な値：
|
VaultId |
| Values |
array |
任意 |
指定されたフィルターキーの値の配列。 |
|
|
string |
任意 |
照合する値。 |
["v-*********************"] |
|
| Operator |
string |
任意 |
照合メソッド。 デフォルト値は IN です。 有効な値：
説明
|
IN |
| Edition |
string |
任意 |
エディション。 有効な値： |
STANDARD |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
リクエストが成功したかどうかを示します。
|
true |
| Code |
string |
リターンコード。 200 の値は、リクエストが成功したことを示します。 |
200 |
| Message |
string |
応答メッセージ。 リクエストが成功した場合、「successful」が返されます。 それ以外の場合は、エラーメッセージが返されます。 |
successful |
| PageNumber |
integer |
返されたページのページ番号。 ページは 1 から始まります。 デフォルト：1。 |
1 |
| PageSize |
integer |
ページあたりのエントリ数。 有効値：1～99。 デフォルト：10。 |
1 |
| TotalCount |
integer |
クエリに一致するエントリの総数。 |
1 |
| RestoreJobs |
object |
復元ジョブの詳細のコンテナ。 |
|
| RestoreJob |
array<object> |
復元ジョブのリスト。 |
{'RestoreJob': []} |
|
array<object> |
復元ジョブの詳細。 |
||
| SnapshotHash |
string |
バックアップスナップショットのハッシュ値。 |
f2fe... |
| Status |
string |
復元ジョブのステータス。 有効な値：
|
COMPLETE |
| ErrorMessage |
string |
復元ジョブのエラーメッセージ。 |
PARTIAL_COMPLETE |
| ActualItems |
integer |
実際に復元されたファイルの数。 このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ返されます。 |
6 |
| VaultId |
string |
バックアップボールトの ID。 |
v-0006******q |
| ActualBytes |
integer |
重複排除後に実際に復元されたデータ量 (バイト単位)。 |
600 |
| UdmDetail |
string |
マシン全体のバックアップの詳細。 |
{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false} |
| SourceType |
string |
データソースのタイプ。 有効な値：
|
ECS_FILE |
| Options |
string |
高度な復元オプション。 このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ返されます。 ボリューム シャドウ コピー サービス (VSS) が使用されたかどうかを示します。
|
{"UseVSS":false} |
| SourceInstanceId |
string |
ソースインスタンスの ID。 |
i-2ze3m7ktcgw******cs |
| RestoreType |
string |
復元ジョブのタイプ。 |
ECS_FILE |
| TargetCreateTime |
integer |
宛先ファイルシステムが作成された時刻。 このパラメーターは、NAS バックアップの場合にのみ返されます。 |
1634714531 |
| ItemsDone |
integer |
復元されたファイルの数。 このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ返されます。 |
8 |
| BytesTotal |
integer |
データソースの合計サイズ (バイト単位)。 |
1000 |
| Exclude |
string |
復元ジョブから除外されたファイルへのパス。 このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ返されます。 各パスの長さは最大 255 文字です。 |
["/var", "/proc"] |
| ParentId |
string |
親ジョブの ID。 |
r-0003hd2an3x4dyv0l18b |
| CompleteTime |
integer |
復元ジョブが完了した時刻。 これは UNIX タイムスタンプ (秒) です。 |
1554347313 |
| CreatedTime |
integer |
復元ジョブが作成された時刻。 これは UNIX タイムスタンプ (秒) です。 |
1554347313 |
| TargetBucket |
string |
宛先バケット。 このパラメーターは、OSS バックアップの場合にのみ返されます。 |
target-bucket |
| ClusterId |
string |
復元ジョブに使用されるクライアントグループの ID。 |
cl-000******hp6 |
| TargetFileSystemId |
string |
宛先ファイルシステムの ID。 このパラメーターは、NAS バックアップの場合にのみ返されます。 |
0be9****9c9 |
| Progress |
integer |
復元ジョブの進捗状況。10000 の値は 100% の完了を示します。 |
10000 |
| ExpireTime |
integer |
復元ジョブの有効期限が切れる時刻。 |
1634714531 |
| TargetDataSourceId |
string |
宛先データソースの ID。 |
ds-000*****997 |
| TargetPrefix |
string |
宛先プレフィックス。 このパラメーターは、OSS バックアップの場合にのみ返されます。 |
"/target" |
| TargetPath |
string |
復元ジョブの宛先パス。 |
"D:\\rebk" |
| ErrorFile |
string |
復元に失敗したファイルのリスト。 |
"test.csv" |
| StartTime |
integer |
復元ジョブが開始された時刻。 これは UNIX タイムスタンプ (秒) です。 |
1554347313 |
| UpdatedTime |
integer |
復元ジョブが最後に更新された時刻。 これは UNIX タイムスタンプ (秒) です。 |
1554347313 |
| SnapshotId |
string |
復元に使用されたスナップショットの ID。 |
s-0002******ga88 |
| RestoreId |
string |
復元ジョブの ID。 |
r-0003*****8a |
| TargetClientId |
string |
宛先クライアントの ID。 |
c-000e*****397 |
| ItemsTotal |
integer |
データソース内のファイルの総数。 このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ返されます。 |
10 |
| Include |
string |
復元ジョブに含まれるファイルへのパス。 |
["/home/alice/*.pdf", "/home/bob/*.txt"] |
| BytesDone |
integer |
復元されたデータ量 (バイト単位)。 |
800 |
| TargetInstanceName |
string |
宛先 Tablestore インスタンスの名前。 |
instancename |
| TargetTableName |
string |
宛先 Tablestore インスタンス内のデータテーブル。 |
tablename |
| Speed |
integer |
平均復元速度 (KB/s)。 |
500 |
| TargetTime |
integer |
Tablestore インスタンスが復元される時点。 これは UNIX タイムスタンプ (秒) です。 |
1642560261 |
| OtsDetail |
object |
Tablestore の復元の詳細。 |
|
| BatchChannelCount |
integer |
各 Tablestore 復元ジョブによって処理されるチャネルの数。 |
2 |
| OverwriteExisting |
boolean |
宛先テーブルの既存のデータが上書きされたかどうかを示します。 |
false |
| CrossAccountType |
string |
クロスアカウントバックアップのタイプ。 有効な値：
|
SELF_ACCOUNT |
| CrossAccountUserId |
integer |
バックアップデータを所有する Alibaba Cloud アカウントの ID。 このパラメーターは、クロスアカウント復元の場合に返されます。 |
158975xxxxxx4625 |
| CrossAccountRoleName |
string |
クロスアカウント復元を実行するためにソースアカウントで引き受けられた RAM ロールの名前。 |
BackupRole |
| Report |
object |
復元ジョブのレポート。 |
|
| TotalFiles |
string |
ファイルベースの復元のすべてのファイルのリストへのパス。 |
/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv |
| SuccessFiles |
string |
正常に復元されたファイルのリストへのパス。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip |
| FailedFiles |
string |
復元に失敗したファイルのリストへのパス。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip |
| SkippedFiles |
string |
スキップされたファイルのリストへのパス。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip |
| ReportTaskStatus |
string |
レポート生成タスクのステータス。 |
COMPLETE |
| MeteringBytesDone |
integer |
復元されたデータの課金対象量 (バイト単位)。 このパラメーターは、`StorageClass` が ARCHIVE に設定されている場合にのみ返されます。 値は最も近い 1 MB に切り上げられます。 |
1048576 |
| MeteringBytesTotal |
integer |
データソース内のデータの課金対象合計量 (バイト単位)。 このパラメーターは、`StorageClass` が ARCHIVE に設定されている場合にのみ返されます。 値は最も近い 1 MB に切り上げられます。 |
1048576 |
| StorageClass |
string |
バックアップデータのストレージクラス。 有効な値：
|
STANDARD |
| FailbackDetail |
string |
VMware フェイルバックジョブの詳細。 |
{"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\",\"dataStoreName\":\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc357i2eannmmotcagz","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false} |
| TargetInstanceId |
string |
宛先インスタンスの ID。 |
i-2ze3m7ktcgw******cs |
| SourceResourceId |
string |
ソースリソースの ID。 |
i-123***7890 |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 1,
"RestoreJobs": {
"RestoreJob": [
{
"SnapshotHash": "f2fe...",
"Status": "COMPLETE",
"ErrorMessage": "PARTIAL_COMPLETE",
"ActualItems": 6,
"VaultId": "v-0006******q",
"ActualBytes": 600,
"UdmDetail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
"SourceType": "ECS_FILE",
"Options": "{\"UseVSS\":false}",
"SourceInstanceId": "i-2ze3m7ktcgw******cs",
"RestoreType": "ECS_FILE",
"TargetCreateTime": 1634714531,
"ItemsDone": 8,
"BytesTotal": 1000,
"Exclude": "[\"/var\", \"/proc\"]",
"ParentId": "r-0003hd2an3x4dyv0l18b",
"CompleteTime": 1554347313,
"CreatedTime": 1554347313,
"TargetBucket": "target-bucket",
"ClusterId": "cl-000******hp6",
"TargetFileSystemId": "0be9****9c9",
"Progress": 10000,
"ExpireTime": 1634714531,
"TargetDataSourceId": "ds-000*****997",
"TargetPrefix": "\"/target\"",
"TargetPath": "\"D:\\\\rebk\"",
"ErrorFile": "\"test.csv\"",
"StartTime": 1554347313,
"UpdatedTime": 1554347313,
"SnapshotId": "s-0002******ga88",
"RestoreId": "r-0003*****8a",
"TargetClientId": "c-000e*****397",
"ItemsTotal": 10,
"Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
"BytesDone": 800,
"TargetInstanceName": "instancename",
"TargetTableName": "tablename",
"Speed": 500,
"TargetTime": 1642560261,
"OtsDetail": {
"BatchChannelCount": 2,
"OverwriteExisting": false
},
"CrossAccountType": "SELF_ACCOUNT",
"CrossAccountUserId": 0,
"CrossAccountRoleName": "BackupRole",
"Report": {
"TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
"SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip\n",
"FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
"SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
"ReportTaskStatus": "COMPLETE"
},
"MeteringBytesDone": 1048576,
"MeteringBytesTotal": 1048576,
"StorageClass": "STANDARD",
"FailbackDetail": "{\"cpu\":4,\"extra\":\"{\\\"restoreVMNamePrefix\\\":\\\"627-\\\",\\\"dataCenterName\\\":\\\"SDDC-Datacenter\\\",\\\"dataStoreId\\\":\\\"datastore-50\\\",\\\"folderId\\\":\\\"group-v49\\\",\\\"resourcePoolId\\\":\\\"resgroup-46\\\",\\\"locationName\\\":\\\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\\\",\\\"computeResourceName\\\":\\\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\\\",\\\"dataStoreName\\\":\\\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\\\",\\\"networkMoReference\\\":\\\"DistributedVirtualPortgroup:dvportgroup-1001\\\",\\\"useHotAdd\\\":false}\",\"instanceId\":\"i-2vc357i2eannmmotcagz\",\"memoryInMB\":8192,\"serverId\":\"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01\",\"uefiBoot\":false}",
"TargetInstanceId": "i-2ze3m7ktcgw******cs",
"SourceResourceId": "i-123***7890"
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。