As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Iniciar um trabalho de backup sob demanda para o recurso especificado.
Sintaxe da Solicitação
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
}
Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- BackupOptions
-
A opção de backup para um recurso selecionado. Essa opção só está disponível para trabalhos de backup do Serviço de Cópias de Sombra de Volume (VSS) do Windows.
Valores válidos: defina como
"WindowsVSS":"enabled"
para habilitar a opção de backup doWindowsVSS
e criar um backup do VSS do Windows. Defina"WindowsVSS""disabled"
como para criar um backup regular. A opçãoWindowsVSS
é habilitada por padrão.Tipo: mapa de strings para string
Padrão da chave:
^[a-zA-Z0-9\-\_\.]{1,50}$
Padrão de valor:
^[a-zA-Z0-9\-\_\.]{1,50}$
Obrigatório: não
- BackupVaultName
-
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: string
Padrão:
^[a-zA-Z0-9\-\_]{2,50}$
Exigido: Sim
- CompleteWindowMinutes
-
Um valor em minutos durante o qual um backup iniciado com êxito deve ser concluído, ou então o AWS Backup cancelará o trabalho. Este valor é opcional. Esse valor começa a contagem regressiva a partir do momento em que o backup foi programado. Isso não adiciona tempo adicional para
StartWindowMinutes
ou, se o backup foi iniciado depois do programado.Como
StartWindowMinutes
, esse parâmetro tem um valor máximo de 100 anos (52.560.000 minutos).Tipo: longo
Obrigatório: não
- IamRoleArn
-
Especifica o ARN do perfil do IAM usado para criar o ponto de recuperação de destino. Por exemplo,
arn:aws:iam::123456789012:role/S3Access
.Tipo: string
Obrigatório: Sim
- IdempotencyToken
-
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas a
StartBackupJob
. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.Tipo: string
Obrigatório: Não
- Index
-
Inclua esse parâmetro para permitir a criação de índices se sua tarefa de backup tiver um tipo de recurso compatível com índices de backup.
Os tipos de recursos que oferecem suporte a índices de backup incluem:
-
EBS
para Amazon Elastic Block Store -
S3
para Amazon Simple Storage Service (Amazon S3)
O índice pode ter 1 de 2 valores possíveis,
ENABLED
ouDISABLED
.Para criar um índice de backup para um ponto de
ACTIVE
recuperação qualificado que ainda não tenha um índice de backup, defina o valor comoENABLED
.Para excluir um índice de backup, defina o valor como
DISABLED
.Tipo: string
Valores Válidos:
ENABLED | DISABLED
Obrigatório: não
-
- Lifecycle
-
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup fará a transição e expirará os backups automaticamente de acordo com o ciclo de vida que você definir.
Os backups transferidos para armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser 90 dias a mais do que a configuração de “número de dias para a transição para o armazenamento frio”. A configuração de "número de dias para transferência ao armazenamento 'frio'" não poderá ser alterada depois que um backup for transferido para o armazenamento "frio".
Os tipos de recursos que podem fazer a transição para o armazenamento refrigerado estão listados na tabela Disponibilidade de recursos por recursos. AWS Backup ignora essa expressão para outros tipos de recursos.
Esse parâmetro tem um valor máximo de 100 anos (36.500 dias).
Tipo: objeto Lifecycle
Obrigatório: não
- RecoveryPointTags
-
As tags a serem atribuídas ao recurso.
Tipo: mapa de strings para string
Obrigatório: não
- ResourceArn
-
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.
Tipo: string
Obrigatório: Sim
- StartWindowMinutes
-
Um valor em minutos após a programação de um backup antes que um trabalho seja cancelado, se ele não for iniciado com êxito. Esse valor é opcional e o padrão é oito horas. Se esse valor for incluído, deve ser de pelo menos 60 minutos para evitar erros.
Esse parâmetro tem um valor máximo de 100 anos (52.560.000 minutos).
Durante a janela inicial, o status do trabalho de backup permanece no status
CREATED
até que seja iniciado com êxito ou até que o tempo da janela inicial se esgote. Se, dentro da janela inicial, o horário AWS Backup receber um erro que permita que o trabalho seja repetido, AWS Backup tentará iniciá-lo automaticamente pelo menos a cada 10 minutos até que o backup seja iniciado com sucesso (o status do trabalho mude paraRUNNING
) ou até que o status do trabalho mude paraEXPIRED
(o que se espera que ocorra quando o tempo da janela inicial terminar).Tipo: longo
Obrigatório: não
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}
Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- BackupJobId
-
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
- CreationDate
-
A data e a hora em que um trabalho de backup foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de
CreationDate
tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: carimbo de data/hora
- IsParent
-
Isso é um valor booliano que indica que se trata de um trabalho de backup pai (composto).
Tipo: booliano
- RecoveryPointArn
-
Observação: esse campo só é retornado para recursos do Amazon EFS e do Advanced DynamoDB.
Um ARN que identifica de forma exclusiva um ponto de recuperação. Por exemplo,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Tipo: string
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
Código de status HTTP: 400
- InvalidRequestException
-
Indica que há algo errado com a entrada da solicitação. Por exemplo, um parâmetro é do tipo errado.
Código de status HTTP: 400
- LimitExceededException
-
Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.
Código de status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
Código de status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
Código de status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
Código de status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: