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

ListBackupJobs

Retorna uma lista dos trabalhos de backup existentes para uma conta autenticada nos últimos 30 dias. Para um período mais longo, considere usar essas ferramentas de monitoramento.

Sintaxe da Solicitação

GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

Parâmetros da Solicitação de URI

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

ByAccountId

O ID da conta a partir da qual listar os trabalhos. Retorna somente os trabalhos de backup associados ao ID da conta especificado.

Se usado em uma conta de gerenciamento do AWS Organizations, passar * retornará todos os trabalhos em toda a organização.

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

ByBackupVaultName

Retorna somente os trabalhos de backup que serão armazenados no cofre de backup especificado. 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.

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

ByCompleteAfter

Retorna somente os trabalhos de backup concluídos após uma data expressa em formato Unix e Tempo Universal Coordenado (UTC).

ByCompleteBefore

Retorna somente os trabalhos de backup concluídos antes de uma data expressa em formato Unix e Tempo Universal Coordenado (UTC).

ByCreatedAfter

Retorna somente os trabalhos de backup que foram criados após a data especificada.

ByCreatedBefore

Retorna somente os trabalhos de backup que foram criados antes da data especificada.

ByMessageCategory

Esse é um parâmetro opcional que pode ser usado para filtrar trabalhos com uma MessageCategory que corresponda ao valor inserido.

Exemplos de strings podem incluir AccessDenied, SUCCESS, AGGREGATE_ALL e InvalidParameters.

Consulte Monitoring.

O curinga () retorna a contagem de todas as categorias de mensagens.

AGGREGATE_ALL agrega as contagens de trabalhos de todas as categorias de mensagens e retorna a soma.

ByParentJobId

Isso é um filtro para listar os trabalhos filho (aninhados) com base no ID do trabalho pai.

ByResourceArn

Retorna somente os trabalhos de backup que correspondam ao Nome do recurso da Amazon (ARN) do recurso especificado.

ByResourceType

Retorna somente os trabalhos de backup para os recursos especificados:

  • Aurora para Amazon Aurora

  • CloudFormation para AWS CloudFormation

  • DocumentDB para Amazon DocumentDB (compatível com MongoDB)

  • DynamoDB para Amazon DynamoDB

  • EBS para Amazon Elastic Block Store

  • EC2 para Amazon Elastic Compute Cloud

  • EFS para Amazon Elastic File System

  • FSx para Amazon FSx

  • Neptune para Amazon Neptune

  • RDS para Amazon Relational Database Service

  • Redshift para Amazon Redshift

  • S3 para Amazon Simple Storage Service (Amazon S3)

  • SAP HANA on Amazon EC2 para bancos de dados SAP HANA em instâncias do Amazon Elastic Compute Cloud

  • Storage Gateway para AWS Storage Gateway

  • Timestream para Amazon Timestream

  • VirtualMachine para máquinas virtuais da VMware

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

ByState

Retorna somente os trabalhos de backup que estejam no estado especificado.

Completed with issues é um status encontrado somente no console do AWS Backup. Para a API, esse status se refere a trabalhos com um estado de COMPLETED e a uma MessageCategory com um valor diferente de SUCCESS, o que significa que o status é Concluído, mas vem com uma mensagem de status.

Para obter a contagem de trabalhos Completed with issues, execute duas solicitações GET e subtraia o número menor:

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

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

MaxResults

O número máximo de itens a serem retornados.

Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.

NextToken

O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número MaxResults de itens, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da resposta

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "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.

BackupJobs

Uma matriz de estruturas contendo metadados sobre os trabalhos de backup retornados no formato JSON.

Tipo: matriz de objetos BackupJob

NextToken

O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número MaxResults de itens, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

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

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 um dos SDKs específicos de linguagem AWS, consulte: