REST Resource: projects.scanConfigs.scanRuns

Ressource : ScanRun

Un ScanRun est une ressource en sortie uniquement représentant une exécution réelle de l'analyse. ID suivant: 12

Représentation JSON 
{
  "name": string,
  "executionState": enum (ExecutionState),
  "resultState": enum (ResultState),
  "startTime": string,
  "endTime": string,
  "urlsCrawledCount": string,
  "urlsTestedCount": string,
  "hasVulnerabilities": boolean,
  "progressPercent": integer,
  "errorTrace": {
    object (ScanRunErrorTrace)
  },
  "warningTraces": [
    {
      object (ScanRunWarningTrace)
    }
  ]
}
Champs
name

string

Uniquement en sortie. Nom de la ressource ScanRun. Le nom se place à la suite du format "projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}". Les ID de ressources ScanRun sont générés par le système.
executionState

enum (ExecutionState)

Uniquement en sortie. État d'exécution du ScanRun.
resultState

enum (ResultState)

Uniquement en sortie. État du résultat du ScanRun. Ce champ n'est disponible que lorsque l'état d'exécution atteint la valeur "FINISHED".
startTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le ScanRun a démarré.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le ScanRun a atteint l'état d'arrêt, indiquant que le ScanRun est terminé ou a été arrêté par l'utilisateur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Uniquement en sortie. Nombre d'URL explorées lors de ce ScanRun. Si l'analyse est en cours, la valeur représente le nombre d'URL explorées jusqu'à présent.
urlsTestedCount

string (int64 format)

Uniquement en sortie. Nombre d'URL testées lors de ce ScanRun. Si l'analyse est en cours, la valeur représente le nombre d'URL testées jusqu'à présent. Le nombre d'URL testées est généralement supérieur au nombre d'URL explorées, car une URL analysée est généralement testée avec plusieurs charges utiles de test.
hasVulnerabilities

boolean

Uniquement en sortie. Indique si l'analyse a détecté des failles ou non.
progressPercent

integer

Uniquement en sortie. Pourcentage d'exécution totale allant de 0 à 100. Si l'analyse est en file d'attente, la valeur est de 0. Si l'analyse est en cours d'exécution, la valeur est comprise entre 0 et 100. Si l'analyse est terminée, la valeur est de 100.
errorTrace

object (ScanRunErrorTrace)

Uniquement en sortie. Si resultState est une erreur, ce champ indique le motif principal de l'arrêt de l'analyse et d'autres informations, le cas échéant.
warningTraces[]

object (ScanRunWarningTrace)

Uniquement en sortie. Liste des avertissements, le cas échéant, rencontrés lors de cette exécution de l'analyse.

ExecutionState

Types d'état d'exécution du ScanRun.

Enums
EXECUTION_STATE_UNSPECIFIED Représente un état non valide provoqué par une erreur de serveur interne. Cette valeur ne devrait jamais être renvoyée.
QUEUED L'analyse est en attente dans la file d'attente.
SCANNING L'analyse est en cours.
FINISHED L'analyse est terminée ou a été arrêtée par l'utilisateur.

ResultState

Types d'état du résultat de ScanRun.

Enums
RESULT_STATE_UNSPECIFIED Valeur par défaut. Cette valeur est renvoyée lorsque le ScanRun n'est pas encore terminé.
SUCCESS L'analyse s'est terminée sans erreur.
ERROR L'analyse s'est terminée avec des erreurs.
KILLED L'analyse a été arrêtée par l'utilisateur.

ScanRunErrorTrace

Uniquement en sortie. Définit un message de trace d'erreur pour un ScanRun.

Représentation JSON 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Champs
code

enum (Code)

Uniquement en sortie. Indique le code de motif d'erreur.
scanConfigError

object (ScanConfigError)

Uniquement en sortie. Si l'analyse rencontre l'erreur SCAN_CONFIG_ISSUE, ce champ contient le message d'erreur rencontré lors de la validation de la configuration de l'analyse, qui est effectuée avant chaque exécution de l'analyse.
mostCommonHttpErrorCode

integer

Uniquement en sortie. Si l'analyse rencontre TOO_MANY_HTTP_ERRORS, ce champ indique le code d'erreur HTTP le plus courant, le cas échéant. Par exemple, si ce code est 404, l'analyse a rencontré trop de réponses NOT_FOUND.

Code

Uniquement en sortie. Définit un code de motif d'erreur. Identifiant suivant: 8

Enums
CODE_UNSPECIFIED La valeur par défaut n'est jamais utilisée.
INTERNAL_ERROR Indique que l'exécution de l'analyse a échoué en raison d'une erreur interne du serveur.
SCAN_CONFIG_ISSUE Indique une erreur de configuration de l'analyse, généralement due à des paramètres ScanConfig obsolètes, tels que les startingUrls ou la configuration DNS.
AUTHENTICATION_CONFIG_ISSUE Indique une erreur d'authentification, généralement due à des paramètres d'authentification ScanConfig obsolètes.
TIMED_OUT_WHILE_SCANNING Indique un délai avant expiration d'une opération d'analyse, généralement causé par un site très volumineux.
TOO_MANY_REDIRECTS Indique qu'une analyse a détecté des redirections excessives, que ce soit vers une page d'authentification ou vers une autre page en dehors du champ d'application de l'analyse.
TOO_MANY_HTTP_ERRORS Indique qu'une analyse a détecté de nombreuses erreurs sur les pages du site Web. Le champ "mostCommonHttpErrorCode" indique le code d'erreur HTTP le plus courant rencontré lors de l'analyse.
STARTING_URLS_CRAWL_HTTP_ERRORS Indique que certaines des URL Web de démarrage ont renvoyé des erreurs HTTP lors de l'analyse.

ScanConfigError

Définit un message d'erreur personnalisé utilisé par les API CreateScanConfig et UpdateScanConfig lorsque la validation de la configuration de l'analyse échoue. Il est également signalé dans un message ScanRunErrorTrace si la validation de l'analyse échoue en raison d'une erreur de configuration de l'analyse.

Représentation JSON 
{
  "code": enum (Code),
  "fieldName": string
}
Champs
code

enum (Code)

Uniquement en sortie. Indique le code de raison d'un échec de configuration.
fieldName

string

Uniquement en sortie. Indique le nom complet du champ ScanConfig qui déclenche cette erreur, par exemple "scanConfig.max_qps". Ce champ est fourni à des fins de dépannage uniquement. Sa valeur réelle peut changer à l'avenir.

Code

Uniquement en sortie. Définit un code de motif d'erreur. ID suivant: 45

Enums
CODE_UNSPECIFIED Il n'y a aucune erreur.
OK Il n'y a aucune erreur.
INTERNAL_ERROR Indique une erreur de serveur interne. Veuillez NE PAS UTILISER CE CODE D'ERREUR, sauf si la cause est vraiment inconnue.
APPENGINE_API_BACKEND_ERROR L'une des URL de référence est une URL App Engine, mais nous ne pouvons pas valider les paramètres d'analyse en raison d'une erreur de backend de l'API App Engine.
APPENGINE_API_NOT_ACCESSIBLE L'une des URL de départ est une URL App Engine, mais nous ne pouvons pas accéder à l'API App Engine pour valider les paramètres d'analyse.
APPENGINE_DEFAULT_HOST_MISSING L'une des URL de départ est une URL App Engine, mais l'hôte par défaut de l'App Engine n'est pas défini.
CANNOT_USE_GOOGLE_COM_ACCOUNT Vous ne pouvez pas utiliser de comptes professionnels Google pour l'analyse.
CANNOT_USE_OWNER_ACCOUNT Le compte du créateur de l'analyse ne peut pas être utilisé pour l'analyse.
COMPUTE_API_BACKEND_ERROR Cette analyse cible Compute Engine, mais nous ne pouvons pas valider les paramètres d'analyse en raison d'une erreur de backend de l'API Compute Engine.
COMPUTE_API_NOT_ACCESSIBLE Cette analyse cible Compute Engine, mais nous ne pouvons pas accéder à l'API Compute Engine pour valider les paramètres d'analyse.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT L'URL de connexion personnalisée n'appartient pas au projet en cours.
CUSTOM_LOGIN_URL_MALFORMED L'URL de connexion personnalisée est incorrecte (impossible de l'analyser).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS L'URL de connexion personnalisée est mappée vers une adresse IP non routable dans le DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS L'URL de connexion personnalisée est mappée avec une adresse IP qui n'est pas réservée au projet en cours.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS L'URL de connexion personnalisée dispose d'une adresse IP ne pouvant pas être routée.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS L'URL de connexion personnalisée comporte une adresse IP qui n'est pas réservée au projet en cours.
DUPLICATE_SCAN_NAME Une autre analyse portant le même nom (majuscules/minuscules) existe déjà.
INVALID_FIELD_VALUE La valeur d'un champ est incorrecte.
FAILED_TO_AUTHENTICATE_TO_TARGET Une erreur s'est produite lors de l'authentification auprès de la cible d'analyse.
FINDING_TYPE_UNSPECIFIED La valeur du type de résultat n'est pas spécifiée dans la requête de liste des résultats.
FORBIDDEN_TO_SCAN_COMPUTE L'analyse cible Compute Engine, mais le projet actuel n'a pas été ajouté à la liste d'autorisation pour l'accès à l'analyse Google Compute Engine Alpha.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN L'utilisateur tente de mettre à jour la recherche gérée
MALFORMED_FILTER Le filtre fourni est incorrect. Par exemple, il ne peut pas être analysé, ne comporte pas de type de filtre dans l'expression ou le même type de filtre apparaît plusieurs fois.
MALFORMED_RESOURCE_NAME Le nom de la ressource fourni n'est pas conforme (impossible de l'analyser).
PROJECT_INACTIVE Le projet actuel n'est pas actif.
REQUIRED_FIELD Un champ obligatoire n'est pas défini.
RESOURCE_NAME_INCONSISTENT L'ID du projet, l'ID de la configuration de numérisation, l'ID de l'exécution de numérisation ou l'ID de la recherche ne sont pas cohérents dans le nom de la ressource.
SCAN_ALREADY_RUNNING L'analyse demandée à démarrer est déjà en cours d'exécution.
SCAN_NOT_RUNNING L'analyse que vous avez demandé à arrêter n'est pas en cours d'exécution.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT L'une des URL de référence n'appartient pas au projet en cours.
SEED_URL_MALFORMED L'une des URL de référence est incorrecte (impossible de l'analyser).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS L'une des URL de référence est mappée sur une adresse IP non routable dans le DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS L'une des URL de référence est mappée sur une adresse IP qui n'est pas réservée pour le projet en cours.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS L'une des URL de départ dispose d'une adresse IP routable.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS L'une des URL de référence dispose d'une adresse IP qui n'est pas réservée pour le projet en cours.
SERVICE_ACCOUNT_NOT_CONFIGURED Le compte de service Web Security Scanner n'est pas configuré dans le projet.
TOO_MANY_SCANS Un projet a atteint le nombre maximal d'analyses.
UNABLE_TO_RESOLVE_PROJECT_INFO Échec de la résolution des détails du projet en cours.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Un ou plusieurs modèles de liste de blocage ne sont pas au bon format.
UNSUPPORTED_FILTER Le filtre fourni n'est pas compatible.
UNSUPPORTED_FINDING_TYPE Le type de résultat fourni n'est pas accepté. Par exemple, nous ne fournissons pas de résultats du type de résultat donné.
UNSUPPORTED_URL_SCHEME Le schéma d'URL d'une ou de plusieurs des URL fournies n'est pas accepté.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND L'inventaire des éléments cloud ne peut pas lister les éléments.

ScanRunWarningTrace

Uniquement en sortie. Définit un message de trace d'avertissement pour ScanRun. Les traces d'avertissement fournissent aux clients des informations utiles qui permettent de rendre le processus d'analyse plus efficace.

Représentation JSON 
{
  "code": enum (Code)
}
Champs
code

enum (Code)

Uniquement en sortie. Indique le code d'avertissement.

Code

Uniquement en sortie. Définit un code de message d'avertissement. Identifiant suivant: 6

Enums
CODE_UNSPECIFIED La valeur par défaut n'est jamais utilisée.
INSUFFICIENT_CRAWL_RESULTS Indique qu'une analyse a détecté un nombre étonnamment peu élevé d'URL. Cela est parfois causé par des fonctionnalités de navigation complexes ou l'utilisation d'une seule URL pour de nombreuses pages.
TOO_MANY_CRAWL_RESULTS Indique qu'une analyse a détecté trop d'URL à tester ou trop d'URL redondantes.
TOO_MANY_FUZZ_TASKS Indique que trop de tests ont été générés pour l'analyse. Le client doit essayer de réduire le nombre d'URL de démarrage, d'augmenter le taux de requêtes par seconde ou de réduire le champ d'application de l'analyse à l'aide des formats à exclure.
BLOCKED_BY_IAP Indique qu'une analyse est bloquée par l'IAP.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Indique qu'aucun point de départ n'a été trouvé pour une analyse

Méthodes

get

 Permet d'obtenir un ScanRun.

list

 Répertorie les ScanRun sous une instance ScanConfig donnée, par ordre décroissant de l'heure de fin de chaque ScanRun.

stop

 Arrête un ScanRun.