ListRestoreJobs
복구 프로세스에 대한 세부 정보를 비롯하여, 저장된 리소스를 복원하기 위해 AWS Backup이 시작한 작업 목록을 반환합니다.
Request Syntax
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
-
지정된 리소스에 대한 복원 작업만 반환하려면 다음 파라미터를 포함하세요.
-
Amazon Aurora의
Aurora -
AWS CloudFormation용
CloudFormation -
Amazon DocumentDB(MongoDB 호환)의
DocumentDB -
Amazon DynamoDB의
DynamoDB -
Amazon Elastic Block Store의
EBS -
Amazon Elastic Compute Cloud의
EC2 -
Amazon Elastic File System의
EFS -
Amazon FSx의
FSx -
Amazon Neptune의
Neptune -
Amazon Relational Database Service의
RDS -
Amazon Redshift의
Redshift -
Amazon Simple Storage Service(Amazon S3)의
S3 -
Amazon Elastic Compute Cloud 인스턴스에 대한 SAP HANA 데이터베이스의
SAP HANA on Amazon EC2 -
Storage Gateway의 경우 AWS Storage Gateway -
Amazon Timestream의
Timestream -
VMware 가상 머신의
VirtualMachine
패턴:
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- ByRestoreTestingPlanArn
-
지정된 리소스의 Amazon 리소스 이름(ARN)과 일치하는 복원 테스트 작업만 반환합니다.
- ByStatus
-
지정된 작업 상태와 관련된 복원 작업만 반환합니다.
유효 값:
PENDING | RUNNING | COMPLETED | ABORTED | FAILED - MaxResults
-
반환할 항목의 최대 수입니다.
유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.
- NextToken
-
반환된 항목의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 항목의
MaxResults수를 반환하기 위한 요청을 한 경우,NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.
Request Body
해당 요청에는 본문이 없습니다.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RestoreJobs": [
{
"AccountId": "string",
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"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",
"SourceResourceArn": "string",
"Status": "string",
"StatusMessage": "string",
"ValidationStatus": "string",
"ValidationStatusMessage": "string"
}
]
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- NextToken
-
반환된 항목의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 항목의
MaxResults수를 반환하기 위한 요청을 한 경우,NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.유형: 문자열
- RestoreJobs
-
저장된 리소스를 복원하기 위한 작업에 대한 세부 정보가 포함된 객체 배열입니다.
타입: RestoreJobsListMember 객체 배열
오류
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- InvalidParameterValueException
-
파라미터의 값에 문제가 있음을 나타냅니다. 예를 들어 값이 범위를 벗어난 경우가 이에 해당합니다.
- Context
- Type
HTTP 상태 코드: 400
- MissingParameterValueException
-
필수 파라미터가 누락되었음을 나타냅니다.
- Context
- Type
HTTP 상태 코드: 400
- ResourceNotFoundException
-
작업에 필요한 리소스가 존재하지 않습니다.
- Context
- Type
HTTP 상태 코드: 400
- ServiceUnavailableException
-
요청이 서버의 일시적 장애 때문에 실패했습니다.
- Context
- Type
HTTP 상태 코드: 500
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
