ListScanJobs - AWS Backup

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ListScanJobs

Devuelve una lista de los trabajos de escaneo existentes para una cuenta autenticada durante los últimos 30 días.

Sintaxis de la solicitud

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 de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

ByAccountId

El ID de la cuenta desde la que se van a enumerar los trabajos. Devuelve solo los trabajos de copia de seguridad asociados al ID de cuenta especificado.

Si se usa desde una AWS cuenta de administración de Organizations, la * transferencia devuelve todos los trabajos de la organización.

Patrón: ^[0-9]{12}$

ByBackupVaultName

Devuelve solo los trabajos de escaneo que se almacenarán en la bóveda de respaldo especificada. Los almacenes de Backup se identifican con nombres que son exclusivos de la cuenta utilizada para crearlos y de la AWS región en la que se crearon.

Patrón: ^[a-zA-Z0-9\-\_\.]{2,50}$

ByCompleteAfter

Solo devuelve los trabajos de escaneo completados después de una fecha expresada en formato Unix y en la hora universal coordinada (UTC).

ByCompleteBefore

Devuelve solo los trabajos de copia de seguridad completados antes de una fecha expresada en formato Unix y horario universal coordinado (UTC).

ByMalwareScanner

Devuelve solo los trabajos de escaneo del escáner de malware especificado. Actualmente solo es compatibleGUARDDUTY.

Valores válidos: GUARDDUTY

ByRecoveryPointArn

Devuelve solo los trabajos de escaneo que se ejecutan en el punto de recuperación especificado.

ByResourceArn

Devuelve solo los trabajos de escaneo que coinciden con el nombre de recurso Amazon (ARN) del recurso especificado.

ByResourceType

Devuelve las selecciones de pruebas de restauración por el nombre del plan de prueba de restauración especificado.

  • EBSpara Amazon Elastic Block Store

  • EC2para Amazon Elastic Compute Cloud

  • S3para Amazon Simple Storage Service (Amazon S3)

Patrón: ^[a-zA-Z0-9\-\_\.]{1,50}$

Valores válidos: EBS | EC2 | S3

ByScanResultStatus

Devuelve solo los trabajos de escaneo para los resultados de escaneo especificados:

  • THREATS_FOUND

  • NO_THREATS_FOUND

Valores válidos: NO_THREATS_FOUND | THREATS_FOUND

ByState

Devuelve solo los trabajos de escaneo para el estado del trabajo de escaneo especificado.

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

MaxResults

Número máximo de elementos que se van a devolver.

Rango válido: valor mínimo de 1. Valor máximo de 1000.

Rango válido: valor mínimo de 1. Valor máximo de 1000.

NextToken

El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos MaxResults, NextToken permite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

NextToken

El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos MaxResults, NextToken permite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.

Tipo: cadena

ScanJobs

Un conjunto de estructuras que contienen metadatos sobre sus trabajos de escaneo devueltos en formato JSON.

Tipo: matriz de objetos ScanJob

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InvalidParameterValueException

Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.

Context

Type

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.

Context

Type

Código de estado HTTP: 500

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: