DescribeBackupJob - AWS Backup
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da respostaElementos de RespostaErrosConsulte também

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á.

DescribeBackupJob

Retorna os detalhes do trabalho de backup para o BackupJobId especificado.

Sintaxe da Solicitação

GET /backup-jobs/backupJobId HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

backupJobId

Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.

Obrigatório: Sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da resposta

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"
}

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.

AccountId

Retorna o ID da conta que é proprietária do trabalho de backup.

Tipo: sequência

Padrão: ^[0-9]{12}$

BackupJobId

Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.

Tipo: String

BackupOptions

Representa as opções especificadas como parte do plano de backup ou do trabalho de backup sob demanda.

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}$

BackupSizeInBytes

O tamanho, em bytes, de um backup (ponto de recuperação).

Esse valor pode ser renderizado de forma diferente dependendo do tipo de recurso, pois AWS Backup extrai informações de dados de outros AWS serviços. Por exemplo, o valor retornado pode mostrar um valor de0, que pode ser diferente do valor previsto.

O comportamento esperado para valores por tipo de recurso é descrito a seguir:

  • O Amazon Aurora, o Amazon DocumentDB e o Amazon Neptune não têm esse valor preenchido a partir da operação. GetBackupJobStatus

  • Para o Amazon DynamoDB com recursos avançados, esse valor se refere ao tamanho do ponto de recuperação (backup).

  • A Amazon EC2 e o Amazon EBS mostram o tamanho do volume (armazenamento provisionado) retornado como parte desse valor. O Amazon EBS não retorna informações sobre o tamanho do backup; o tamanho do snapshot terá o mesmo valor do recurso original do qual foi feito o backup.

  • Para o Amazon EFS, esse valor se refere aos bytes delta transferidos durante um backup.

  • FSx A Amazon não preenche esse valor da operação GetBackupJobStatus para sistemas de FSx arquivos.

  • Uma instância do Amazon RDS será exibida como0.

  • Para máquinas virtuais em execução VMware, esse valor é passado AWS Backup por meio de um fluxo de trabalho assíncrono, o que pode significar que esse valor exibido pode subrepresentar o tamanho real do backup.

Tipo: longo

BackupType

Representa o tipo real de backup selecionado para um trabalho de backup. Por exemplo, se um backup bem-sucedido do Serviço de Cópias de Sombra de Volume (VSS) do Windows tiver sido feito, o BackupType retornará "WindowsVSS". Se BackupType estiver vazio, então o tipo de backup foi um backup normal.

Tipo: String

BackupVaultArn

Um Nome do recurso da Amazon (ARN) que identifica exclusivamente um cofre de backup, por exemplo, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Tipo: String

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}$

BytesTransferred

O tamanho em bytes transferido para um cofre de backup no momento em que o status do trabalho foi consultado.

Tipo: longo

ChildJobsInState

Isso retorna as estatísticas dos trabalhos de backup filho (aninhados) incluídos.

Tipo: mapa de string para string

Chaves válidas: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

A data e a hora em que um trabalho de criação de backup é concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de CompletionDate 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

CreatedBy

Contém informações de identificação sobre a criação de uma tarefa de backup, incluindo BackupPlanArn, BackupPlanId, BackupPlanVersion e BackupRuleId do plano de backup usado para criá-lo.

Tipo: objeto RecoveryPointCreator

CreationDate

A data e hora em que o trabalho de backup foi criado, em formato de hora 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

EncryptionKeyArn

O Amazon Resource Name (ARN) da chave KMS usada para criptografar o backup. Ela pode ser uma chave gerenciada pelo cliente ou uma chave AWS gerenciada, dependendo da configuração do cofre.

Tipo: String

ExpectedCompletionDate

A data e a hora em que se espera que um trabalho de backup de recursos seja concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de ExpectedCompletionDate 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

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

InitiationDate

A data em que um trabalho de backup foi iniciado.

Tipo: Timestamp

IsEncrypted

Um valor booleano que indica se o backup está criptografado. Todos os backups AWS Backup são criptografados, mas esse campo indica o status da criptografia para fins de transparência.

Tipo: booliano

IsParent

Isso retorna o valor booliano de que um trabalho de backup é um trabalho pai (composto).

Tipo: booliano

MessageCategory

A contagem de trabalhos para a categoria de mensagem especificada.

Exemplos de strings podem incluir AccessDenied, SUCCESS, AGGREGATE_ALL e INVALIDPARAMETERS. Veja Monitoramento para obter uma lista de MessageCategory sequências de caracteres aceitas.

Tipo: String

NumberOfChildJobs

Isso retorna o número de trabalhos de backup filho (aninhados).

Tipo: longo

ParentJobId

Isso retorna o ID do trabalho de backup do recurso pai (composto).

Tipo: String

PercentDone

Contém uma porcentagem estimada de conclusão de um trabalho no momento em que o status do trabalho foi consultado.

Tipo: String

RecoveryPointArn

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

RecoveryPointLifecycle

Especifica o período, em dias, antes de um ponto de recuperação fazer a transição para o armazenamento a frio, ou seja excluído.

Os backups transferidos para armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, no console, a configuração de retenção deve ser 90 dias a mais do que a transição para frio após a configuração de dias. A transição para frio após a configuração de dias não poderá ser alterada depois que um backup for transferido para 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.

Para remover o ciclo de vida e os períodos de retenção existentes e manter seus pontos de recuperação indefinidamente, especifique -1 para MoveToColdStorageAfterDays e DeleteAfterDays.

Tipo: objeto Lifecycle

ResourceArn

Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.

Tipo: String

ResourceName

O nome não exclusivo do recurso que pertence ao backup especificado.

Tipo: String

ResourceType

O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).

Tipo: sequência

Padrão: ^[a-zA-Z0-9\-\_\.]{1,50}$

StartBy

Especifica a hora em formato Unix e Tempo Universal Coordenado (UTC) em que uma tarefa de backup deve ser iniciada antes que seja cancelada. O valor é calculado adicionando a janela inicial ao horário programado. Portanto, se o horário programado fosse às 18h e a janela inicial fosse 2 horas, o horário StartBy seria às 20h na data especificada. O valor de StartBy 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

State

O estado atual de um trabalho de backup.

Tipo: String

Valores Válidos: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

StatusMessage

Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.

Tipo: String

VaultLockState

O estado de bloqueio do cofre de backup. Para cofres logicamente fechados, isso indica se o cofre está bloqueado no modo de conformidade. Os valores válidos são LOCKED e UNLOCKED.

Tipo: String

VaultType

O tipo de cofre de backup em que o ponto de recuperação está armazenado. Os valores válidos são BACKUP_VAULT para cofres de backup padrão e LOGICALLY_AIR_GAPPED_BACKUP_VAULT para cofres logicamente isolados.

Tipo: String

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

DependencyFailureException

Um AWS serviço ou recurso dependente retornou um erro ao AWS Backup serviço e a ação não pode ser concluída.

Context

Type

Código de status HTTP: 500

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

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 uma das linguagens específicas AWS SDKs, consulte o seguinte: