REST Resource: projects.scanConfigs.scanRuns

Risorsa: ScanRun

Una ScanRun è una risorsa solo per l'output che rappresenta un'esecuzione effettiva della scansione. ID successivo: 12

Rappresentazione 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)
    }
  ]
}
Campi
name

string

Solo output. Il nome della risorsa della corsa di scansione. Il nome segue il formato "projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}". Gli ID ScanRun vengono generati dal sistema.
executionState

enum (ExecutionState)

Solo output. Lo stato di esecuzione di ScanRun.
resultState

enum (ResultState)

Solo output. Lo stato del risultato dell'esecuzione della scansione. Questo campo è disponibile solo dopo che lo stato di esecuzione raggiunge "FINISHED".
startTime

string (Timestamp format)

Solo output. L'ora in cui è iniziata l'esecuzione di ScanRun.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Solo output. L'ora in cui la ScanRun ha raggiunto lo stato di terminazione, ovvero è stata completata o interrotta dall'utente.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Solo output. Il numero di URL sottoposti a scansione durante questa esecuzione della scansione. Se la scansione è in corso, il valore rappresenta il numero di URL sottoposti a scansione fino a quel momento.
urlsTestedCount

string (int64 format)

Solo output. Il numero di URL testati durante questa esecuzione della scansione. Se la scansione è in corso, il valore rappresenta il numero di URL testati fino a quel momento. In genere, il numero di URL testati è superiore al numero di URL sottoposti a scansione perché in genere un URL sottoposto a scansione viene testato con più payload di test.
hasVulnerabilities

boolean

Solo output. Indica se la scansione ha rilevato vulnerabilità.
progressPercent

integer

Solo output. La percentuale di completamento totale varia da 0 a 100. Se la scansione è in coda, il valore è 0. Se la ricerca è in esecuzione, il valore va da 0 a 100. Se la scansione è terminata, il valore è 100.
errorTrace

object (ScanRunErrorTrace)

Solo output. Se resultState è ERROR, questo campo fornisce il motivo principale dell'interruzione della scansione e ulteriori dettagli, se disponibili.
warningTraces[]

object (ScanRunWarningTrace)

Solo output. Un elenco di avvisi, se rilevati durante l'esecuzione della scansione.

ExecutionState

Tipi di stato di esecuzione di ScanRun.

Enum
EXECUTION_STATE_UNSPECIFIED Rappresenta uno stato non valido causato da un errore interno del server. Questo valore non deve mai essere restituito.
QUEUED L'analisi è in attesa in coda.
SCANNING La scansione è in corso.
FINISHED La scansione è terminata o è stata interrotta dall'utente.

ResultState

Tipi di stato del risultato di ScanRun.

Enum
RESULT_STATE_UNSPECIFIED Valore predefinito. Questo valore viene restituito quando l'esecuzione della scansione non è ancora terminata.
SUCCESS La scansione è stata completata senza errori.
ERROR La scansione è stata completata con errori.
KILLED La scansione è stata interrotta dall'utente.

ScanRunErrorTrace

Solo output. Definisce un messaggio di traccia di errore per una ScanRun.

Rappresentazione JSON 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Campi
code

enum (Code)

Solo output. Indica il codice del motivo dell'errore.
scanConfigError

object (ScanConfigError)

Solo output. Se la scansione rileva l'errore SCAN_CONFIG_ISSUE, questo campo contiene il messaggio di errore rilevato durante la convalida della configurazione della scansione, che viene eseguita prima di ogni esecuzione della scansione.
mostCommonHttpErrorCode

integer

Solo output. Se la scansione rileva TOO_MANY_HTTP_ERRORS, questo campo indica il codice di errore HTTP più comune, se disponibile. Ad esempio, se questo codice è 404, la scansione ha rilevato troppe risposte NOT_FOUND.

Codice

Solo output. Definisce un codice del motivo dell'errore. ID successivo: 8

Enum
CODE_UNSPECIFIED Il valore predefinito non viene mai utilizzato.
INTERNAL_ERROR Indica che l'esecuzione della scansione non è riuscita a causa di un errore interno del server.
SCAN_CONFIG_ISSUE Indica un errore di configurazione della scansione, in genere dovuto a impostazioni ScanConfig obsolete, ad esempio startingUrls o la configurazione DNS.
AUTHENTICATION_CONFIG_ISSUE Indica un errore di autenticazione, in genere dovuto a impostazioni di autenticazione ScanConfig obsolete.
TIMED_OUT_WHILE_SCANNING Indica un timeout dell'operazione di scansione, in genere causato da un sito molto grande.
TOO_MANY_REDIRECTS Indica che una scansione ha rilevato un numero eccessivo di reindirizzamenti, all'autenticazione o ad altre pagine esterne all'ambito della scansione.
TOO_MANY_HTTP_ERRORS Indica che una scansione ha rilevato numerosi errori nelle pagine del sito web. Se disponibile, il campo mostCommonHttpErrorCode indica il codice di errore HTTP più comune rilevato durante la scansione.
STARTING_URLS_CRAWL_HTTP_ERRORS Indica che alcuni degli URL web di partenza hanno restituito errori HTTP durante la scansione.

ScanConfigError

Definisce un messaggio di errore personalizzato utilizzato dalle API CreateScanConfig e UpdateScanConfig quando la convalida della configurazione della ricerca non va a buon fine. Viene segnalato anche all'interno di un messaggio ScanRunErrorTrace se la convalida dell'analisi non va a buon fine a causa di un errore di configurazione dell'analisi.

Rappresentazione JSON 
{
  "code": enum (Code),
  "fieldName": string
}
Campi
code

enum (Code)

Solo output. Indica il codice del motivo di un errore di configurazione.
fieldName

string

Solo output. Indica il nome completo del campo ScanConfig che attiva questo errore, ad esempio "scanConfig.max_qps". Questo campo viene fornito solo per la risoluzione dei problemi e il relativo valore effettivo può cambiare in futuro.

Codice

Solo output. Definisce un codice del motivo dell'errore. ID successivo: 45

Enum
CODE_UNSPECIFIED Non sono presenti errori.
OK Non sono presenti errori.
INTERNAL_ERROR Indica un errore interno del server. NON UTILIZZARE QUESTO CODICE DI ERRORE a meno che la causa principale non sia davvero sconosciuta.
APPENGINE_API_BACKEND_ERROR Uno degli URL seme è un URL di App Engine, ma non possiamo convalidare le impostazioni di scansione a causa di un errore del backend dell'API App Engine.
APPENGINE_API_NOT_ACCESSIBLE Uno degli URL seme è un URL di App Engine, ma non possiamo accedere all'API App Engine per convalidare le impostazioni di scansione.
APPENGINE_DEFAULT_HOST_MISSING Uno degli URL seme è un URL di App Engine, ma l'host predefinito di App Engine non è impostato.
CANNOT_USE_GOOGLE_COM_ACCOUNT Non puoi utilizzare gli account aziendali Google per la scansione.
CANNOT_USE_OWNER_ACCOUNT L'account dell'autore della scansione non può essere utilizzato per la scansione.
COMPUTE_API_BACKEND_ERROR Questa scansione ha come target Compute Engine, ma non possiamo convalidare le impostazioni di scansione a causa di un errore di backend dell'API Compute Engine.
COMPUTE_API_NOT_ACCESSIBLE Questa scansione ha come target Compute Engine, ma non possiamo accedere all'API Compute Engine per convalidare le impostazioni di scansione.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT L'URL di accesso personalizzato non appartiene al progetto corrente.
CUSTOM_LOGIN_URL_MALFORMED L'URL di accesso personalizzato non è corretto (non può essere analizzato).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS L'URL di accesso personalizzato è mappato a un indirizzo IP non instradabile nel DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS L'URL di accesso personalizzato è mappato a un indirizzo IP non riservato per il progetto corrente.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS L'URL di accesso personalizzato ha un indirizzo IP non instradabile.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS L'URL di accesso personalizzato ha un indirizzo IP non riservato per il progetto corrente.
DUPLICATE_SCAN_NAME Esiste già un'altra scansione con lo stesso nome (sensibile alle maiuscole).
INVALID_FIELD_VALUE Un campo è impostato su un valore non valido.
FAILED_TO_AUTHENTICATE_TO_TARGET Si è verificato un errore durante il tentativo di autenticazione al target di scansione.
FINDING_TYPE_UNSPECIFIED Il valore del tipo di risultati non è specificato nella richiesta di risultati dell'elenco.
FORBIDDEN_TO_SCAN_COMPUTE La scansione ha come target Compute Engine, ma il progetto corrente non è stato inserito nella lista consentita per l'accesso in anteprima a Google Compute Engine Scanning.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN L'utente tenta di aggiornare la ricerca gestita
MALFORMED_FILTER Il filtro fornito non è nel formato corretto. Ad esempio, non può essere analizzato, non ha un tipo di filtro nell'espressione o lo stesso tipo di filtro viene visualizzato più di una volta.
MALFORMED_RESOURCE_NAME Il nome della risorsa fornito non è valido (non può essere analizzato).
PROJECT_INACTIVE Il progetto attuale non è in stato attivo.
REQUIRED_FIELD Un campo obbligatorio non è impostato.
RESOURCE_NAME_INCONSISTENT L'ID progetto, l'ID scanconfig, l'ID scanrun o l'ID della segnalazione non sono coerenti tra loro nel nome della risorsa.
SCAN_ALREADY_RUNNING La scansione di cui è stata richiesta l'avvio è già in esecuzione.
SCAN_NOT_RUNNING La scansione di cui è stata richiesta l'interruzione non è in esecuzione.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Uno degli URL seme non appartiene al progetto corrente.
SEED_URL_MALFORMED Uno degli URL seme non è valido (non può essere analizzato).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Uno degli URL di origine è mappato a un indirizzo IP non instradabile in DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS Uno degli URL di origine è mappato a un indirizzo IP non riservato per il progetto attuale.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS Uno degli URL seme ha un indirizzo IP instradabile.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS Uno degli URL seme ha un indirizzo IP non riservato per il progetto corrente.
SERVICE_ACCOUNT_NOT_CONFIGURED L'account di servizio Web Security Scanner non è configurato nel progetto.
TOO_MANY_SCANS Un progetto ha raggiunto il numero massimo di scansioni.
UNABLE_TO_RESOLVE_PROJECT_INFO La risoluzione dei dettagli del progetto corrente non va a buon fine.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Uno o più pattern della lista nera non sono nel formato corretto.
UNSUPPORTED_FILTER Il filtro fornito non è supportato.
UNSUPPORTED_FINDING_TYPE Il tipo di rilevamento fornito non è supportato. Ad esempio, non forniamo risultati del tipo specificato.
UNSUPPORTED_URL_SCHEME Lo schema URL di uno o più degli URL forniti non è supportato.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND CAI non è in grado di elencare gli asset.

ScanRunWarningTrace

Solo output. Definisce un messaggio di traccia di avviso per ScanRun. Le tracce di avviso forniscono ai clienti informazioni utili che contribuiscono a rendere più efficace il processo di scansione.

Rappresentazione JSON 
{
  "code": enum (Code)
}
Campi
code

enum (Code)

Solo output. Indica il codice di avviso.

Codice

Solo output. Definisce un codice messaggio di avviso. ID successivo: 6

Enum
CODE_UNSPECIFIED Il valore predefinito non viene mai utilizzato.
INSUFFICIENT_CRAWL_RESULTS Indica che una scansione ha rilevato un numero inaspettatamente basso di URL. Ciò è dovuto a volte a funzioni di navigazione complesse o all'uso di un singolo URL per numerose pagine.
TOO_MANY_CRAWL_RESULTS Indica che una scansione ha rilevato troppi URL da sottoporre a test o un numero eccessivo di URL ridondanti.
TOO_MANY_FUZZ_TASKS Indica che sono stati generati troppi test per la scansione. Il cliente deve provare a ridurre il numero di URL di avvio, ad aumentare la frequenza QPS o a restringere l'ambito della scansione utilizzando i pattern esclusi.
BLOCKED_BY_IAP Indica che una scansione è bloccata dall'IAP.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Indica che non sono stati trovati semi per una scansione

Metodi

get

 Recupera un'esecuzione ScanRun.

list

 Elenca le esecuzioni di scansione in una determinata ScanConfig, in ordine decrescente in base all'ora di interruzione dell'esecuzione di scansione.

stop

 Interrompe un'esecuzione scansione.