StartBackupJob - AWS Backup

StartBackupJob

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 do WindowsVSS e criar um backup do VSS do Windows. Defina "WindowsVSS""disabled" como para criar um backup regular. A opção WindowsVSS é habilitada por padrão.

Tipo: mapa de string 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: sequência

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 o trabalho de backup tiver um tipo de recurso compatível com índices de backup.

Os tipos de recursos compatíveis com í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 ou DISABLED.

Para criar um índice de backup para um ponto de recuperação ACTIVE qualificado que ainda não tenha um índice de backup, defina o valor como ENABLED.

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 "frio" e quando ele expira. O AWS Backup fará a transferência e a expiração de 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 a frio” não pode ser alterada depois que um backup é transferido para o armazenamento a frio.

Os tipos de recursos que podem ser transferidos para o armazenamento a frio estão listados na tabela Disponibilidade de recursos por recurso. O AWS Backup ignora essa expressão para outros tipos de recurso.

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 string 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 do tempo da janela inicial, o AWS Backup receber um erro que permita que o trabalho seja repetido, o AWS Backup tentará iniciá-lo automaticamente pelo menos a cada 10 minutos até que o backup seja iniciado com êxito (o status do trabalho mude para RUNNING) ou até que o status do trabalho mude para EXPIRED (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 o 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: Timestamp

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.

Context

Type

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.

Context

Type

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.

Context

Type

Código de Status HTTP: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

Context

Type

Código de Status HTTP: 400

ResourceNotFoundException

Um recurso necessário para a ação não existe.

Context

Type

Código de Status HTTP: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

Context

Type

Código de Status HTTP: 500

Consulte também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: