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

ListCopyJobs

Retorna metadados sobre seus trabalhos de cópia.

Sintaxe da Solicitação

GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&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 cópia associados ao ID da conta especificada.

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

ByCompleteAfter

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

ByCompleteBefore

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

ByCreatedAfter

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

ByCreatedBefore

Retorna somente os trabalhos de cópia que foram criados antes da data especificada.

ByDestinationVaultArn

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

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 para conferir uma lista de strings aceitas.

O valor ANY 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 cópia que correspondam ao Nome do recurso da Amazon (ARN) 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 cópia que estão no estado especificado.

Valores Válidos: CREATED | RUNNING | COMPLETED | FAILED | 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 a quantidade MaxResults de itens, 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

{
   "CopyJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "ChildJobsInState": { 
            "string" : number 
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CopyJobId": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "DestinationBackupVaultArn": "string",
         "DestinationRecoveryPointArn": "string",
         "IamRoleArn": "string",
         "IsParent": boolean,
         "MessageCategory": "string",
         "NumberOfChildJobs": number,
         "ParentJobId": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "SourceRecoveryPointArn": "string",
         "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.

CopyJobs

Uma matriz de estruturas contendo metadados sobre seus trabalhos de cópia retornados no formato JSON.

Tipo: matriz de objetos CopyJob

NextToken

O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar a quantidade MaxResults de itens, 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: