StartBackupJob
지정한 리소스에 대한 온디맨드 백업 작업을 시작합니다.
Request Syntax
PUT /backup-jobs HTTP/1.1
Content-type: application/json
{
"BackupOptions": {
"string" : "string"
},
"BackupVaultName": "string",
"CompleteWindowMinutes": number,
"IamRoleArn": "string",
"IdempotencyToken": "string",
"Index": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointTags": {
"string" : "string"
},
"ResourceArn": "string",
"StartWindowMinutes": number
}
URI 요청 파라미터
요청은 URI 파라미터를 사용하지 않습니다.
요청 본문
요청은 JSON 형식으로 다음 데이터를 받습니다.
- BackupOptions
-
선택한 리소스에 대한 백업 옵션입니다. 이 옵션은 Windows VSS(Volume Shadow Copy Service) 백업 작업에만 사용할 수 있습니다.
유효한 값:
WindowsVSS백업 옵션을 활성화하고 Windows VSS 백업을 생성하려면"WindowsVSS":"enabled"로 설정합니다. 정기 백업을 생성하려면"WindowsVSS""disabled"로 설정합니다.WindowsVSS옵션은 기본적으로 활성화되어 있습니다.유형: 문자열 간 맵
키 패턴:
^[a-zA-Z0-9\-\_\.]{1,50}$값 패턴:
^[a-zA-Z0-9\-\_\.]{1,50}$필수 여부: 아니요
- BackupVaultName
-
백업이 저장되는 논리 컨테이너의 이름입니다. 백업 저장소는 백업 저장소가 생성된 AWS 리전 및 백업 저장소를 생성하는 데 사용된 계정에 고유 이름으로 식별됩니다.
유형: String
패턴:
^[a-zA-Z0-9\-\_]{2,50}$필수 여부: 예
- CompleteWindowMinutes
-
성공적으로 시작된 백업을 완료해야 하는 기간(분)입니다. 완료하지 않으면 AWS Backup이 작업을 취소합니다. 이 값은 선택 사항입니다. 이 값은 백업이 예약된 시점부터 감소되기 시작합니다. 백업이 일정보다 늦게 시작된 경우에도
StartWindowMinutes에 대한 추가 시간이 추가되지 않습니다.StartWindowMinutes와 마찬가지로, 이 파라미터의 최대값은 100년(52,560,000분)입니다.유형: Long
필수 여부: 아니요
- IamRoleArn
-
대상 복구 시점을 생성하는 데 사용되는 IAM 역할 ARN을 지정합니다(예:
arn:aws:iam::123456789012:role/S3Access).유형: 문자열
필수 항목 여부: 예
- IdempotencyToken
-
고객이 선택한 문자열로,
StartBackupJob에 대한 동일한 호출을 구분하는 데 사용할 수 있습니다. 동일한 멱등성 토큰으로 성공적인 요청을 다시 시도하면 아무런 작업 없이 성공 메시지가 표시됩니다.유형: 문자열
필수 여부: 아니요
- Index
-
백업 작업에 백업 인덱스를 지원하는 리소스 유형이 있는 경우 인덱스 생성을 활성화하려면 이 파라미터를 포함합니다.
백업 인덱스를 지원하는 리소스 유형은 다음과 같습니다.
-
Amazon Elastic Block Store의
EBS -
Amazon Simple Storage Service(Amazon S3)의
S3
인덱스에는
ENABLED또는DISABLED의 두 가지 가능한 값 중 하나가 있을 수 있습니다.아직 백업 인덱스가 없는 적격
ACTIVE복구 시점에 대한 백업 인덱스를 생성하려면 값을ENABLED로 설정합니다.백업 인덱스를 삭제하려면 값을
DISABLED로 설정합니다.타입: 문자열
유효 값:
ENABLED | DISABLED필수 여부: 아니요
-
- Lifecycle
-
수명 주기는 보호된 리소스가 콜드 스토리지로 전환되는 시기와 만료되는 시점을 정의합니다. AWS Backup은 사용자가 정의한 수명 주기에 따라 백업을 자동으로 전환하고 만료합니다.
콜드 스토리지로 전환된 백업은 콜드 스토리지에서 최소 90일 이상 저장되어야 합니다. 따라서 ‘보존’ 설정은 ‘콜드로 전환 전 보관 일수’ 설정보다 90일 이상 커야 합니다. 백업이 콜드로 전환된 후 "콜드로 전환 전 보관 일수" 설정을 변경할 수 없습니다.
콜드 스토리지로 전환할 수 있는 리소스 유형은 리소스별 기능 가용성 표에 나열되어 있습니다. AWS Backup는 다른 리소스 유형에 대해서는 이 표현식을 무시합니다.
이 파라미터의 최대값은 100년(36,500일)입니다.
유형: Lifecycle객체
필수 여부: 아니요
- RecoveryPointTags
-
리소스에 할당할 태그입니다.
유형: 문자열 대 문자열 맵
필수 여부: 아니요
- ResourceArn
-
리소스를 고유하게 식별하는 Amazon 리소스 이름(ARN)입니다. ARN의 형식은 리소스 유형에 따라 달라집니다.
유형: 문자열
필수 항목 여부: 예
- StartWindowMinutes
-
백업이 예약된 후 작업이 성공적으로 시작되지 않은 경우 취소되기 전까지의 시간(분)입니다. 이 값은 선택 사항이며, 기본값은 8시간입니다. 이 값이 포함된 경우 오류를 방지하려면 60분 이상이어야 합니다.
이 파라미터의 최대값은 100년(52,560,000분)입니다.
시작 기간 동안에는 백업 작업이 성공적으로 시작되거나 시작 기간이 만료될 때까지 백업 작업 상태가
CREATED상태로 유지됩니다. 시작 기간 내에 작업을 재시도할 수 있는 오류 메시지가 AWS Backup에 표시될 경우, AWS Backup는 백업이 성공적으로 시작하거나(작업 상태가RUNNING으로 변경) 작업 상태가EXPIRED로 변경될 때까지(시작 기간이 끝나면 변경이 이루어짐) 최소 10분마다 작업을 자동으로 재시도합니다.유형: Long
필수 항목 여부: 아니요
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- BackupJobId
-
리소스를 백업하기 위한 AWS Backup에 대한 요청을 고유하게 식별합니다.
유형: 문자열
- CreationDate
-
백업 작업이 생성된 날짜 및 시간(Unix 형식 및 협정 세계시(UTC))입니다.
CreationDate의 값은 밀리초 단위로 정확합니다. 예를 들어, 1516925490.087이라는 값은 2018년 1월 26일 금요일 오전 12:11:30.087을 나타냅니다.유형: 타임스탬프
- IsParent
-
상위(복합) 백업 작업이라는 것을 나타내는 반환된 부울 값입니다.
유형: 부울
- RecoveryPointArn
-
참고: 이 필드는 Amazon EFS 및 고급 DynamoDB 리소스에 대해서만 반환됩니다.
복구 시점을 고유하게 식별하는 ARN입니다(예:
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45).유형: 문자열
오류
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- InvalidParameterValueException
-
파라미터의 값에 문제가 있음을 나타냅니다. 예를 들어 값이 범위를 벗어난 경우가 이에 해당합니다.
- Context
- Type
HTTP 상태 코드: 400
- InvalidRequestException
-
요청에 대한 입력에 문제가 있음을 나타냅니다. 예를 들어, 파라미터의 유형이 잘못된 경우가 이에 해당합니다.
- Context
- Type
HTTP 상태 코드: 400
- LimitExceededException
-
요청의 한도가 초과되었습니다(예: 요청에 허용되는 최대 항목 수).
- Context
- Type
HTTP 상태 코드: 400
- MissingParameterValueException
-
필수 파라미터가 누락되었음을 나타냅니다.
- Context
- Type
HTTP 상태 코드: 400
- ResourceNotFoundException
-
작업에 필요한 리소스가 존재하지 않습니다.
- Context
- Type
HTTP 상태 코드: 400
- ServiceUnavailableException
-
요청이 서버의 일시적 장애 때문에 실패했습니다.
- Context
- Type
HTTP 상태 코드: 500
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.