DescribeBackupJob - AWS Backup

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

URIParâmetros de solicitação

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

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", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "ExpectedCompletionDate": number, "IamRoleArn": "string", "InitiationDate": number, "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string" }

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

AccountId

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

Tipo: string

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 de um backup, em bytes.

Tipo: longo

BackupType

Representa o tipo real de backup selecionado para um trabalho de backup. Por exemplo, se um backup bem-sucedido do Windows Volume Shadow Copy Service (VSS) foi feito, ele BackupType retorna"WindowsVSS". Se BackupType estiver vazio, então o tipo de backup foi um backup normal.

Tipo: string

BackupVaultArn

Um nome de 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: string

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 para criar um trabalho de backup é concluído, no formato Unix e no 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: carimbo de data/hora

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 a hora em que uma tarefa de backup é criada, no formato Unix e na Hora Universal Coordenada (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

ExpectedCompletionDate

A data e a hora em que se espera que um trabalho de backup de recursos seja concluído, no formato Unix e no 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: carimbo de data/hora

IamRoleArn

Especifica a IAM função ARN usada para criar o ponto de recuperação de destino; por exemplo,arn:aws:iam::123456789012:role/S3Access.

Tipo: string

InitiationDate

A data em que uma tarefa de backup foi iniciada.

Tipo: carimbo de data/hora

IsParent

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

Tipo: booliano

MessageCategory

A contagem de tarefas 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

E 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

ResourceArn

E ARN isso 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 (AmazonEBS) ou um banco de dados do Amazon Relational Database Service (RDSAmazon).

Tipo: string

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

StartBy

Especifica a hora no formato Unix e na Hora Universal Coordenada (UTC) em que uma tarefa de backup deve ser iniciada antes de ser 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: carimbo de data/hora

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

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.

HTTPCódigo de status: 500

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

HTTPCódigo de status: 400

MissingParameterValueException

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

HTTPCódigo de status: 400

ResourceNotFoundException

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

HTTPCódigo de status: 400

ServiceUnavailableException

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

HTTPCódigo de status: 500

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: