ListCopyJobs - AWS Backup

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

ListCopyJobs

복사 작업에 대한 메타데이터를 반환합니다.

Request Syntax

GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI 요청 파라미터

요청은 다음 URI 파라미터를 사용합니다.

ByAccountId

작업을 나열할 계정 ID입니다. 지정된 계정 ID와 관련된 복사 작업만 반환합니다.

패턴: ^[0-9]{12}$

ByCompleteAfter

Unix 형식 및 협정 세계시(UTC)로 표시된 날짜 이후에 완료된 복사 작업만 반환합니다.

ByCompleteBefore

Unix 형식 및 협정 세계시(UTC)로 표시된 날짜 이전에 완료된 복사 작업만 반환합니다.

ByCreatedAfter

지정된 날짜 이후에 생성된 복사 작업만 반환합니다.

ByCreatedBefore

지정된 날짜 이전에 생성된 복사 작업만 반환합니다.

ByDestinationVaultArn

복사하는 위치인 소스 백업 저장소를 고유하게 식별하는 Amazon 리소스 이름(ARN)입니다(예: arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault).

ByMessageCategory

입력한 값과 일치하는 MessageCategory가 있는 작업을 필터링하는 데 사용할 수 있는 선택적 파라미터입니다.

예시 문자열에는 AccessDenied, SUCCESS, AGGREGATE_ALL, INVALIDPARAMETERS 등이 있습니다.

모니터링에서 허용되는 문자열 목록을 확인하세요.

ANY 값은 모든 메시지 범주의 개수를 반환합니다.

AGGREGATE_ALL은 모든 메시지 범주의 작업 수를 집계하고 그 합계를 반환합니다.

ByParentJobId

상위 작업 ID를 기준으로 하위(중첩) 작업을 나열하는 필터입니다.

ByResourceArn

지정된 리소스 Amazon 리소스 이름(ARN)과 일치하는 복사 작업만 반환합니다.

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

  • AWS Storage Gateway용 Storage Gateway

  • Amazon Timestream의 Timestream

  • VMware 가상 머신의 VirtualMachine

패턴: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByState

지정된 상태에 있는 복사 작업만 반환합니다.

유효 값: CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

MaxResults

반환할 항목의 최대 수입니다.

유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.

NextToken

반환된 항목의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 항목의 MaxResults 수를 반환하기 위한 요청을 한 경우, NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.

Request Body

해당 요청에는 본문이 없습니다.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CopyJobs": [ { "AccountId": "string", "BackupSizeInBytes": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CompositeMemberIdentifier": "string", "CopyJobId": "string", "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "DestinationBackupVaultArn": "string", "DestinationRecoveryPointArn": "string", "IamRoleArn": "string", "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "SourceRecoveryPointArn": "string", "State": "string", "StatusMessage": "string" } ], "NextToken": "string" }

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

CopyJobs

JSON 형식으로 반환되는 복사 작업에 대한 메타데이터가 들어 있는 구조의 배열.

유형: CopyJob객체 어레이

NextToken

반환된 항목의 일부 목록 다음에 나오는 다음 항목입니다. 예를 들어, 항목의 MaxResults 수를 반환하기 위한 요청을 한 경우, NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.

유형: 문자열

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

InvalidParameterValueException

파라미터의 값에 문제가 있음을 나타냅니다. 예를 들어 값이 범위를 벗어난 경우가 이에 해당합니다.

HTTP 상태 코드: 400

ServiceUnavailableException

요청이 서버의 일시적 장애 때문에 실패했습니다.

HTTP 상태 코드: 500

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.