本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListRestoreJobs
傳回 AWS Backup 啟動以還原已儲存資源的任務清單,包括復原程序的詳細資訊。
請求語法
GET /restore-jobs/?accountId=ByAccountId
&completeAfter=ByCompleteAfter
&completeBefore=ByCompleteBefore
&createdAfter=ByCreatedAfter
&createdBefore=ByCreatedBefore
&maxResults=MaxResults
&nextToken=NextToken
&resourceType=ByResourceType
&restoreTestingPlanArn=ByRestoreTestingPlanArn
&status=ByStatus
HTTP/1.1
URI 請求參數
請求使用以下URI參數。
- ByAccountId
-
列出任務的帳戶 ID。僅傳回與指定帳戶 ID 相關聯的還原任務。
模式:
^[0-9]{12}$
- ByCompleteAfter
-
僅傳回以 Unix 格式和國際標準時間 () 表示的日期之後完成的複製任務UTC。
- ByCompleteBefore
-
僅傳回以 Unix 格式和國際標準時間 () 表示之日期之前完成的複製任務UTC。
- ByCreatedAfter
-
僅傳回在指定日期之後建立的還原任務。
- ByCreatedBefore
-
僅傳回在指定日期之前建立的還原任務。
- ByResourceType
-
包含此參數以僅傳回指定資源的還原任務:
-
Aurora
代表 Amazon Aurora -
CloudFormation
適用於 AWS CloudFormation -
DocumentDB
代表 Amazon DocumentDB (with MongoDB compatibility) -
DynamoDB
代表 Amazon DynamoDB -
EBS
代表 Amazon Elastic Block Store -
EC2
代表 Amazon Elastic Compute Cloud -
EFS
代表 Amazon Elastic File System -
FSx
適用於 Amazon FSx -
Neptune
代表 Amazon Neptune -
RDS
代表 Amazon Relational Database Service -
Redshift
代表 Amazon Redshift -
S3
適用於 Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2
適用於 Amazon Elastic Compute Cloud 執行個體上的SAPHANA資料庫 -
Storage Gateway
適用於 AWS Storage Gateway -
Timestream
代表 Amazon Timestream -
VirtualMachine
適用於VMware虛擬機器
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
-
- ByRestoreTestingPlanArn
-
這只會傳回符合指定資源 Amazon Resource Name () 的還原測試任務ARN。
- ByStatus
-
僅傳回與指定任務狀態相關聯的還原任務。
有效值:
PENDING | RUNNING | COMPLETED | ABORTED | FAILED
- MaxResults
-
所要傳回的項目數量上限。
有效範圍:最小值為 1。最大值為 1000。
- NextToken
-
傳回項目之部分列表後的下一個項目。例如,如果請求傳回
MaxResults
個數量的項目,則NextToken
允許您從下一個字符指向的位置開始傳回列表中的更多項目。
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RestoreJobs": [
{
"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"
}
]
}
回應元素
如果動作成功,服務會傳回 200 HTTP 個回應。
服務會以 JSON 格式傳回下列資料。
- NextToken
-
傳回項目之部分列表後的下一個項目。例如,如果請求傳回
MaxResults
個數量的項目,則NextToken
允許您從下一個字符指向的位置開始傳回列表中的更多項目。類型:字串
- RestoreJobs
-
物件陣列,其中包含還原所儲存資源之任務的詳細資訊。
類型:RestoreJobsListMember 物件陣列
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼:400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: