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.
DescribeScanJob
Renvoie les détails de la tâche de numérisation pour l' ScanJobID spécifié.
Syntaxe de la demande
GET /scan/jobs/ScanJobId HTTP/1.1
Paramètres de demande URI
La demande utilise les paramètres URI suivants.
- ScanJobId
-
Identifie de manière unique une demande AWS Backup d'analyse d'une ressource.
Obligatoire : oui
Corps de la demande
La demande n’a pas de corps de requête.
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"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.
- AccountId
-
Renvoie l'ID du compte auquel appartient la tâche de numérisation.
Modèle :
^[0-9]{12}$Type : Chaîne
- BackupVaultArn
-
Un Amazon Resource Name (ARN) qui identifie de manière unique un coffre-fort de sauvegarde ; par exemple,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultType : Chaîne
- BackupVaultName
-
Le nom d'un conteneur logique où les sauvegardes sont stockées. 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}$Type : Chaîne
- CompletionDate
-
Date et heure de fin de création d'un index de sauvegarde, au format Unix et en temps universel coordonné (UTC). La valeur de
CompletionDateest précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.Type : Timestamp
- CreatedBy
-
Contient des informations d'identification relatives à la création d'une tâche d'analyse, notamment le plan de sauvegarde et la règle à l'origine de l'analyse.
Type : objet ScanJobCreator
- CreationDate
-
Date et heure de fin de création d'un index de sauvegarde, au format Unix et en temps universel coordonné (UTC). La valeur de
CreationDateest précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.Type : Timestamp
- IamRoleArn
-
Amazon Resource Name (ARN) qui identifie de façon unique un coffre-fort de sauvegarde ; par exemple,
arn:aws:iam::123456789012:role/S3Access.Type : Chaîne
- MalwareScanner
-
Moteur d'analyse utilisé pour la tâche de numérisation correspondante. Actuellement, seul
GUARDUTYest pris en charge.Type : Chaîne
Valeurs valides :
GUARDDUTY - RecoveryPointArn
-
Un ARN qui identifie de manière unique le point de récupération cible à scanner. ; par exemple,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.Type : Chaîne
- ResourceArn
-
Un ARN qui identifie de manière unique la ressource source de l'ARN du point de récupération correspondant.
Type : Chaîne
- ResourceName
-
Nom non unique de la ressource appartenant à la sauvegarde spécifiée.
Type : Chaîne
- ResourceType
-
Type de AWS ressource à sauvegarder ; par exemple, un volume Amazon Elastic Block Store (Amazon EBS).
Modèle :
^[a-zA-Z0-9\-\_\.]{1,50}$Type : Chaîne
Valeurs valides :
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
Un ARN qui identifie de manière unique le point de récupération de base à scanner. Ce champ ne sera rempli que lorsqu'une tâche de numérisation incrémentielle aura eu lieu.
Type : Chaîne
- ScanId
-
L'ID de scan généré par Amazon GuardDuty pour la demande d'ID de scan Job correspondante auprès de AWS Backup.
Type : Chaîne
- ScanJobId
-
L'ID de la tâche de numérisation qui a identifié de manière unique la demande adressée à AWS Backup.
Type : Chaîne
- ScanMode
-
Spécifie le type de numérisation utilisé pour la tâche de numérisation.
Type : Chaîne
Valeurs valides :
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
Spécifie l'ARN du rôle IAM du scanner utilisé pour la tâche de numérisation.
Type : Chaîne
- ScanResult
-
Contient le
ScanResultsStatuspour le travail de numérisation et les retoursTHREATS_FOUNDouNO_THREATS_FOUNDpour les travaux terminés.Type : objet ScanResultInfo
- State
-
État actuel d'une tâche de numérisation.
Type : Chaîne
Valeurs valides :
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
Message détaillé expliquant le statut de la tâche de sauvegarde d'une ressource.
Type : Chaîne
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
- MissingParameterValueException
-
Indique qu'un paramètre obligatoire est manquant.
- Context
- Type
Code d’état HTTP : 400
- ResourceNotFoundException
-
Aucune ressource requise pour l'action n'existe.
- 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 :
