本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeRestoreJob
傳回與任務 ID 所指定還原任務相關聯的中繼資料。
請求語法
GET /restore-jobs/restoreJobId
HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- restoreJobId
-
可唯一識別還原復原點的任務。
必要:是
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"AccountId": "string",
"BackupSizeInBytes": number,
"CompletionDate": number,
"CreatedBy": {
"RestoreTestingPlanArn": "string"
},
"CreatedResourceArn": "string",
"CreationDate": number,
"DeletionStatus": "string",
"DeletionStatusMessage": "string",
"ExpectedCompletionTimeMinutes": number,
"IamRoleArn": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"RecoveryPointCreationDate": number,
"ResourceType": "string",
"RestoreJobId": "string",
"Status": "string",
"StatusMessage": "string",
"ValidationStatus": "string",
"ValidationStatusMessage": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AccountId
-
傳回擁有還原任務的帳戶 ID。
類型:String
模式:
^[0-9]{12}$
- BackupSizeInBytes
-
所還原資源的大小,以位元組為單位。
類型:Long
- CompletionDate
-
還原復原點任務的完成日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。
CompletionDate
的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- CreatedBy
-
包含有關建立還原任務的識別資訊。
類型:RestoreJobCreator 物件
- CreatedResourceArn
-
還原任務所建立之資源的 Amazon 資源名稱 (ARN)。
ARN 的格式取決於備份資源的資源類型。
類型:字串
- CreationDate
-
建立還原任務時的日期和時間,以 Unix 格式和國際標準時間 (UTC) 顯示。
CreationDate
的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型:Timestamp
- DeletionStatus
-
還原測試所產生的資料狀態。
類型:字串
有效值:
DELETING | FAILED | SUCCESSFUL
- DeletionStatusMessage
-
此會說明還原任務刪除狀態。
類型:字串
- ExpectedCompletionTimeMinutes
-
還原復原點之任務預計所需的時間 (分鐘)。
類型:Long
- IamRoleArn
-
指定用來建立目標復原點的 IAM 角色 ARN;例如
arn:aws:iam::123456789012:role/S3Access
。類型:字串
- PercentDone
-
包含查詢任務狀態時,任務的預估完成百分比。
類型:字串
- RecoveryPointArn
-
可唯一識別復原點的 ARN;例如
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
。類型:字串
- RecoveryPointCreationDate
-
指定的還原工作所建立之復原點的建立日期。
類型:Timestamp
- ResourceType
-
傳回與依資源類型列出之還原任務相關聯的中繼資料。
類型:String
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
- RestoreJobId
-
可唯一識別還原復原點的任務。
類型:字串
- Status
-
狀態碼,指定還原復原點所 AWS Backup 起始之工作的狀態。
類型:字串
有效值:
PENDING | RUNNING | COMPLETED | ABORTED | FAILED
- StatusMessage
-
顯示還原復原點任務狀態的訊息。
類型:字串
- ValidationStatus
-
在指定的還原工作上執行驗證的狀態。
類型:字串
有效值:
FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING
- ValidationStatusMessage
-
狀態訊息。
類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- DependencyFailureException
-
相依 AWS 服務或資源將錯誤傳回給 AWS Backup 服務,且動作無法完成。
HTTP 狀態碼:500
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼:400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
HTTP 狀態碼:500
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: