DescribeBackupJob - AWS Backup

DescribeBackupJob

지정된 BackupJobId에 대한 백업 작업 세부 정보를 반환합니다.

Request Syntax

GET /backup-jobs/backupJobId HTTP/1.1

URI 요청 파라미터

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

backupJobId

리소스를 백업하기 위한 AWS Backup에 대한 요청을 고유하게 식별합니다.

필수 여부: 예

Request Body

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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AccountId": "string", "BackupJobId": "string", "BackupOptions": { "string" : "string" }, "BackupSizeInBytes": number, "BackupType": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanName": "string", "BackupPlanVersion": "string", "BackupRuleCron": "string", "BackupRuleId": "string", "BackupRuleName": "string", "BackupRuleTimezone": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "ExpectedCompletionDate": number, "IamRoleArn": "string", "InitiationDate": number, "IsEncrypted": boolean, "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RecoveryPointLifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string", "VaultLockState": "string", "VaultType": "string" }

응답 요소

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

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

AccountId

백업 작업을 소유한 계정 ID를 반환합니다.

유형: String

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

BackupJobId

리소스를 백업하기 위한 AWS Backup에 대한 요청을 고유하게 식별합니다.

유형: 문자열

BackupOptions

백업 계획 또는 온디맨드 백업 작업의 일부로 지정된 옵션을 나타냅니다.

유형: 문자열 간 맵

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

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

BackupSizeInBytes

백업(복구 시점)의 바이트 단위 크기입니다.

AWS Backup가 다른 AWS 서비스에서 데이터 정보를 가져오므로 이 값은 리소스 유형에 따라 다르게 표현될 수 있습니다. 예를 들어 반환된 값은 0 값을 표시할 수 있으며, 이는 예상 값과 다를 수 있습니다.

리소스 유형별 값에 대한 예상 동작은 다음과 같습니다.

  • Amazon Aurora, Amazon DocumentDB 및 Amazon Neptune에는 GetBackupJobStatus 작업에서 이 값이 채워지지 않습니다.

  • 고급 기능이 있는 Amazon DynamoDB의 경우 이 값은 복구 시점(백업)의 크기를 나타냅니다.

  • Amazon EC2 및 Amazon EBS는 이 값의 일부로 반환된 볼륨 크기(프로비저닝된 스토리지)를 표시합니다. Amazon EBS는 백업 크기 정보를 반환하지 않습니다. 스냅샷 크기는 백업된 원래 리소스와 동일한 값을 갖습니다.

  • Amazon EFS의 경우 이 값은 백업 중에 전송된 델타 바이트를 나타냅니다.

  • Amazon FSx는 FSx 파일 시스템의 GetBackupJobStatus 작업에서 이 값을 채우지 않습니다.

  • Amazon RDS 인스턴스는 0로 표시됩니다.

  • VMware를 실행하는 가상 머신의 경우 이 값은 비동기 워크플로를 통해 AWS Backup로 전달되므로 표시된 값이 실제 백업 크기보다 작게 표현될 수 있습니다.

타입: Long

BackupType

백업 작업을 위해 선택한 실제 백업 유형을 나타냅니다. 예를 들어, Windows VSS(Volume Shadow Copy Service) 백업이 성공적으로 수행된 경우 BackupType"WindowsVSS"를 반환합니다. BackupType이 비어 있는 경우 백업 유형은 일반 백업입니다.

유형: 문자열

BackupVaultArn

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

유형: 문자열

BackupVaultName

백업이 저장되는 논리 컨테이너의 이름입니다. 백업 저장소는 백업 저장소가 생성된 AWS 리전 및 백업 저장소를 생성하는 데 사용된 계정에 고유 이름으로 식별됩니다.

유형: String

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

BytesTransferred

작업 상태를 쿼리할 때 백업 저장소로 전송된 크기(바이트)입니다.

타입: Long

ChildJobsInState

포함된 하위(중첩) 백업 작업의 통계를 반환합니다.

유형: 문자열과 Long 간의 맵

유효한 키: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

백업 작업을 생성하기 위한 작업이 완료된 날짜 및 시간(Unix 형식 및 협정 세계시(UTC))입니다. CompletionDate의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.

유형: 타임스탬프

CreatedBy

백업 작업을 생성하는 데 사용되는 백업 계획의 BackupPlanArn, BackupPlanId, BackupPlanVersion, BackupRuleId를 비롯하여, 백업 작업의 생성에 대한 식별 정보를 포함합니다.

유형: RecoveryPointCreator객체

CreationDate

백업 작업이 생성된 날짜 및 시간(Unix 형식 및 협정 세계시(UTC))입니다. CreationDate의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.

유형: 타임스탬프

EncryptionKeyArn

백업을 암호화하는 데 사용되는 KMS 키의 Amazon 리소스 이름(ARN)입니다. 이는 저장소 구성에 따라 고객 관리형 키 또는 AWS 관리형 키일 수 있습니다.

유형: 문자열

ExpectedCompletionDate

리소스를 백업하는 작업이 완료될 것으로 예상되는 날짜 및 시간(Unix 형식 및 협정 세계시(UTC))입니다. ExpectedCompletionDate의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.

유형: 타임스탬프

IamRoleArn

대상 복구 시점을 생성하는 데 사용되는 IAM 역할 ARN을 지정합니다(예: arn:aws:iam::123456789012:role/S3Access).

유형: 문자열

InitiationDate

백업 작업이 시작된 날짜입니다.

유형: 타임스탬프

IsEncrypted

백업 암호화 여부를 나타내는 부울 값입니다. AWS Backup의 모든 백업은 암호화되지만 이 필드는 투명성을 위한 암호화 상태를 나타냅니다.

유형: 부울

IsParent

백업 작업이 상위(복합) 작업인 부울 값을 반환합니다.

유형: 부울

MessageCategory

지정된 메시지 범주의 작업 수입니다.

예시 문자열에는 AccessDenied, SUCCESS, AGGREGATE_ALL, INVALIDPARAMETERS 등이 있습니다. 모니터링에서 허용되는 MessageCategory 문자열 목록을 확인하세요.

유형: 문자열

NumberOfChildJobs

하위(중첩) 백업 작업 수를 반환합니다.

타입: Long

ParentJobId

상위(복합) 리소스 백업 작업 ID를 반환합니다.

유형: 문자열

PercentDone

작업 상태를 쿼리할 때 작업의 예상 완료율을 포함합니다.

유형: 문자열

RecoveryPointArn

복구 시점을 고유하게 식별하는 ARN입니다(예: arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45).

유형: 문자열

RecoveryPointLifecycle

복구 시점이 콜드 스토리지로 전환되거나 삭제되기 전까지의 기간(일)을 지정합니다.

콜드 스토리지로 전환된 백업은 콜드 스토리지에서 최소 90일 이상 저장되어야 합니다. 따라서 콘솔에서 보존 설정은 '콜드로 전환 전 보관 일수' 설정보다 90일 이상 커야 합니다. 백업이 콜드로 전환된 후에는 '콜드로 전환 전 보관 일수' 설정을 변경할 수 없습니다.

콜드 스토리지로 전환할 수 있는 리소스 유형은 리소스별 기능 가용성 표에 나열되어 있습니다. AWS Backup는 다른 리소스 유형에 대해서는 이 표현식을 무시합니다.

기존 수명 주기 및 보존 기간을 제거하고 복구 시점을 무기한 유지하려면 MoveToColdStorageAfterDaysDeleteAfterDays를 -1로 지정합니다.

유형: Lifecycle객체

ResourceArn

저장된 리소스를 고유하게 식별하는 ARN입니다. ARN의 형식은 리소스 유형에 따라 달라집니다.

유형: 문자열

ResourceName

지정된 백업에 속하는 리소스의 고유하지 않은 이름입니다.

유형: 문자열

ResourceType

백업할 AWS 리소스 유형입니다(예: Amazon Elastic Block Store(Amazon EBS) 볼륨 또는 Amazon Relational Database Service(Amazon RDS) 데이터베이스).

유형: String

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

StartBy

백업 작업을 취소하기 전에 시작해야 하는 시간을 Unix 형식 및 협정 세계시(UTC)로 지정합니다. 이 값은 시작 기간을 예약된 시간에 더하여 계산됩니다. 따라서 예약된 시간이 오후 6시이고 시작 기간이 2시간인 경우, StartBy 시간은 지정된 날짜의 오후 8시가 됩니다. StartBy의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.

유형: 타임스탬프

State

백업 작업의 현재 상태입니다.

타입: 문자열

유효 값: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

StatusMessage

리소스를 백업하기 위한 작업의 상태를 설명하는 자세한 메시지입니다.

유형: 문자열

VaultLockState

백업 저장소의 잠금 상태입니다. 논리적 에어 갭 저장소의 경우, 이는 저장소가 규정 준수 모드에서 잠겨 있는지 여부를 나타냅니다. 유효한 값에는 LOCKEDUNLOCKED(이)가 있습니다.

유형: 문자열

VaultType

복구 지점이 저장되는 백업 저장소의 유형입니다. 유효한 값은 표준 백업 저장소의 경우 BACKUP_VAULT이고 논리적 에어 갭 저장소의 경우 LOGICALLY_AIR_GAPPED_BACKUP_VAULT입니다.

유형: 문자열

오류

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

DependencyFailureException

종속 AWS 서비스 또는 리소스가 AWS Backup 서비스에 오류를 반환하며, 작업을 완료할 수 없습니다.

Context

Type

HTTP 상태 코드: 500

InvalidParameterValueException

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

Context

Type

HTTP 상태 코드: 400

MissingParameterValueException

필수 파라미터가 누락되었음을 나타냅니다.

Context

Type

HTTP 상태 코드: 400

ResourceNotFoundException

작업에 필요한 리소스가 존재하지 않습니다.

Context

Type

HTTP 상태 코드: 400

ServiceUnavailableException

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

Context

Type

HTTP 상태 코드: 500

참고

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