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

ListScanJobs

Retorna uma lista dos trabalhos de digitalização existentes para uma conta autenticada nos últimos 30 dias.

Sintaxe da Solicitação

GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken 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 da AWS Organizations, o passe * retorna todos os trabalhos em toda a organização.

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

ByBackupVaultName

Retorna somente trabalhos de digitalização que serão armazenados no cofre de backup especificado. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.

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

ByCompleteAfter

Retorna somente trabalhos de digitalização concluídos após uma data expressa no formato Unix e no 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).

ByMalwareScanner

Retorna somente os trabalhos de verificação do verificador de malware especificado. Atualmente, só suportaGUARDDUTY.

Valores válidos: GUARDDUTY

ByRecoveryPointArn

Retorna somente os trabalhos de digitalização executados no ponto de recuperação especificado.

ByResourceArn

Retorna somente trabalhos de digitalização que correspondam ao recurso Amazon Resource Name (ARN) especificado.

ByResourceType

Retorna as seleções de testes de restauração pelo nome do plano de testes de restauração especificado.

  • EBSpara Amazon Elastic Block Store

  • EC2para Amazon Elastic Compute Cloud

  • S3para o Amazon Simple Storage Service (Amazon S3)

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

Valores válidos: EBS | EC2 | S3

ByScanResultStatus

Retorna somente os trabalhos de escaneamento para os resultados de escaneamento especificados:

  • THREATS_FOUND

  • NO_THREATS_FOUND

Valores válidos: NO_THREATS_FOUND | THREATS_FOUND

ByState

Retorna somente os trabalhos de digitalização para o estado do trabalho de digitalização especificado.

Valores válidos: CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING

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.

Faixa válida: 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

{
   "NextToken": "string",
   "ScanJobs": [ 
      { 
         "AccountId": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "IamRoleArn": "string",
         "MalwareScanner": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "ScanBaseRecoveryPointArn": "string",
         "ScanId": "string",
         "ScanJobId": "string",
         "ScanMode": "string",
         "ScannerRoleArn": "string",
         "ScanResult": { 
            "ScanResultStatus": "string"
         },
         "State": "string",
         "StatusMessage": "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.

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

ScanJobs

Uma matriz de estruturas contendo metadados sobre seus trabalhos de digitalização retornados no formato JSON.

Tipo: matriz de objetos ScanJob

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

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: