ListScanJobs - AWS Backup
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListScanJobs

Renvoie une liste des tâches de scan existantes pour un compte authentifié au cours des 30 derniers jours.

Syntaxe de la demande

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

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

ByAccountId

L'ID du compte à partir duquel répertorier les tâches. Renvoie uniquement les tâches de sauvegarde associées à l'ID de compte spécifié.

S'il est utilisé à partir d'un compte de gestion d' AWS Organizations, le transfert * renvoie toutes les offres d'emploi au sein de l'organisation.

Modèle : ^[0-9]{12}$

ByBackupVaultName

Renvoie uniquement les tâches de numérisation qui seront stockées dans le coffre de sauvegarde spécifié. Les coffres-forts de sauvegarde sont identifiés par des noms propres au compte utilisé pour les créer et à la AWS région dans laquelle ils ont été créés.

Modèle : ^[a-zA-Z0-9\-\_\.]{2,50}$

ByCompleteAfter

Renvoie uniquement les tâches de numérisation terminées après une date exprimée au format Unix et en temps universel coordonné (UTC).

ByCompleteBefore

Renvoie uniquement les tâches de sauvegarde terminées avant une date exprimée au format Unix et au format UTC (temps universel coordonné).

ByMalwareScanner

Renvoie uniquement les tâches d'analyse pour le scanner de programmes malveillants spécifié. Actuellement, seuls les supportsGUARDDUTY.

Valeurs valides : GUARDDUTY

ByRecoveryPointArn

Renvoie uniquement les tâches d'analyse exécutées sur le point de récupération spécifié.

ByResourceArn

Renvoie uniquement les tâches de scan qui correspondent à la ressource Amazon Resource Name (ARN) spécifiée.

ByResourceType

Renvoie les sélections de tests de la restauration en fonction du nom du plan de tests de la restauration spécifié.

  • EBSpour Amazon Elastic Block Store

  • EC2pour Amazon Elastic Compute Cloud

  • S3pour Amazon Simple Storage Service (Amazon S3)

Modèle : ^[a-zA-Z0-9\-\_\.]{1,50}$

Valeurs valides : EBS | EC2 | S3

ByScanResultStatus

Renvoie uniquement les tâches d'analyse pour les résultats d'analyse spécifiés :

  • THREATS_FOUND

  • NO_THREATS_FOUND

Valeurs valides : NO_THREATS_FOUND | THREATS_FOUND

ByState

Renvoie uniquement les tâches de numérisation correspondant à l'état de tâche de numérisation spécifié.

Valeurs valides : CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING

MaxResults

Le nombre maximum d'éléments à renvoyer.

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

Corps de la requête

La demande n’a pas de corps de requête.

Syntaxe de la réponse

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"
      }
   ]
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

NextToken

L'élément suivant selon une liste partielle des éléments renvoyés. Par exemple, si une demande est faite pour renvoyer MaxResults éléments, NextToken vous permet de renvoyer d'autres éléments dans votre liste en commençant par l'emplacement indiqué par le jeton suivant.

Type : Chaîne

ScanJobs

Tableau de structures contenant des métadonnées relatives à vos tâches de numérisation renvoyées au format JSON.

Type : tableau d’objets ScanJob

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InvalidParameterValueException

Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.

Context

Type

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué en raison d'une défaillance temporaire du serveur.

Context

Type

Code d’état HTTP : 500

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :