REST Resource: projects.scanConfigs.scanRuns

Ressource: ScanRun

Ein ScanRun ist eine reine Ausgaberessource, die eine tatsächliche Ausführung des Scans darstellt. Nächste ID: 12

JSON-Darstellung 
{
  "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)
    }
  ]
}
Felder
name

string

Der Ressourcenname des ScanRun. Der Name hat das Format "projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}". Die ScanRun-IDs werden vom System generiert.
executionState

enum (ExecutionState)

Der Ausführungsstatus des ScanRun.
resultState

enum (ResultState)

Der Ergebnisstatus des ScanRun. Dieses Feld ist nur verfügbar, wenn der Ausführungsstatus "FERTIG" anzeigt.
startTime

string (Timestamp format)

Der Zeitpunkt, zu dem der ScanRun gestartet wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Der Zeitpunkt, zu dem der ScanRun beendet ist – entweder abgeschlossen oder vom Nutzer angehalten.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Die Anzahl der URLs, die während dieses ScanRun gecrawlt wurden. Wenn der Scan gerade ausgeführt wird, entspricht der Wert der Anzahl der bisher gecrawlten URLs.
urlsTestedCount

string (int64 format)

Die Anzahl der URLs, die während dieses ScanRun getestet wurden. Wenn der Scan gerade ausgeführt wird, entspricht der Wert der Anzahl der bisher getesteten URLs. Die Anzahl der getesteten URLs ist normalerweise größer als die Anzahl der gecrawlten URLs. Das liegt daran, dass eine gecrawlte URL in der Regel mit mehreren Testnutzlasten getestet wird.
hasVulnerabilities

boolean

Gibt an, ob der ScanRun Sicherheitslücken gefunden hat.
progressPercent

integer

Der Fortschritt als Wert zwischen 0 und 100 %. Während sich der Scan in der Warteschlange befindet, ist der Wert 0. Wenn der Scan gerade ausgeführt wird, liegt der Wert zwischen 0 und 100 %. Wenn der Scan abgeschlossen ist, ist der Wert 100 %.
errorTrace

object (ScanRunErrorTrace)

Wenn resultState ein FEHLER ist, enthält dieses Feld den Hauptgrund für die Beendigung des Scans sowie weitere Details, sofern verfügbar.
warningTraces[]

object (ScanRunWarningTrace)

Eine Liste mit Warnungen, wenn während des ScanRun Warnmeldungen auftreten.

ExecutionState

Arten von ScanRun-Ausführungsstatus

Enums
EXECUTION_STATE_UNSPECIFIED Stellt einen ungültigen Status dar, der durch einen internen Serverfehler verursacht wurde. Dieser Wert sollte niemals zurückgegeben werden.
QUEUED Der Scan befindet sich in der Warteschlange.
SCANNING Der Scanvorgang läuft.
FINISHED Der Scan ist entweder beendet oder wurde vom Nutzer angehalten.

ResultState

Arten von ScanRun-Ergebnisstatus

Enums
RESULT_STATE_UNSPECIFIED Standardwert. Dieser Wert wird zurückgegeben, wenn der ScanRun noch nicht beendet ist.
SUCCESS Der Scan wurde ohne Fehler beendet.
ERROR Der Scan wurde mit Fehlern beendet.
KILLED Der Scan wurde vom Nutzer abgebrochen.

ScanRunErrorTrace

Nur Ausgabe. Definiert eine Fehlertrace-Meldung für einen ScanRun.

JSON-Darstellung 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Felder
code

enum (Code)

Zeigt den Ursachencode für den Fehler an.
scanConfigError

object (ScanConfigError)

Wenn während des Scans der Fehler "SCAN_CONFIG_ISSUE" auftritt, wird in diesem Feld die Fehlermeldung angezeigt, die während der Überprüfung der Scankonfiguration vor jedem Scanlauf festgestellt wurde.
mostCommonHttpErrorCode

integer

Wenn während des Scans der Fehler "TOO_MANY_HTTP_ERRORS" auftritt, zeigt dieses Feld den häufigsten HTTP-Fehlercode an, sofern dieser verfügbar ist. Wenn dieser Code beispielsweise 404 lautet, gab es zu viele "NOT_FOUND"-Antworten.

Code

Nur Ausgabe. Definiert den Ursachencode für den Fehler. Nächste ID: 8

Enums
CODE_UNSPECIFIED Der Standardwert wird nie verwendet.
INTERNAL_ERROR Gibt an, dass der Scanlauf aufgrund eines internen Serverfehlers fehlgeschlagen ist.
SCAN_CONFIG_ISSUE Gibt an, dass ein Scankonfigurationsfehler aufgetreten ist. Das passiert in der Regel aufgrund veralteter ScanConfig-Einstellungen, beispielsweise startingUrls oder der DNS-Konfiguration.
AUTHENTICATION_CONFIG_ISSUE Gibt an, dass ein Authentifizierungsfehler aufgetreten ist. Das passiert in der Regel aufgrund veralteter ScanConfig-Authentifizierungseinstellungen.
TIMED_OUT_WHILE_SCANNING Gibt an, dass die Zeit für einen Scan abgelaufen ist. Das wird in der Regel durch eine sehr große Site verursacht.
TOO_MANY_REDIRECTS Gibt an, dass es bei einem Scan übermäßig viele Weiterleitungen gab, entweder zu Authentifizierungsseiten oder anderen Seiten außerhalb des Scanbereichs.
TOO_MANY_HTTP_ERRORS Gibt an, dass bei einem Scan zahlreiche Fehler auf den Seiten der Website aufgetreten sind. Im Feld "mostCommonHttpErrorCode" wird der häufigste während des Scans gefundene HTTP-Fehlercode angezeigt, sofern verfügbar.
STARTING_URLS_CRAWL_HTTP_ERRORS Gibt an, dass bei einigen der Start-URLs während des Scans HTTP-Fehler zurückgegeben wurden.

ScanConfigError

Definiert eine benutzerdefinierte Fehlermeldung, die von den APIs „CreateScanConfig“ und „UpdateScanConfig“ verwendet wird, wenn die Überprüfung der Scankonfiguration fehlschlägt. Sie erscheint auch als Teil einer ScanRunErrorTrace-Meldung, wenn die Überprüfung des Scans aufgrund eines Scankonfigurationsfehlers fehlschlägt.

JSON-Darstellung 
{
  "code": enum (Code),
  "fieldName": string
}
Felder
code

enum (Code)

Gibt den Ursachencode für einen Konfigurationsfehler an.
fieldName

string

Gibt den vollständigen Namen des diesen Fehler auslösenden ScanConfig-Felds an, beispielsweise "scanConfig.max_qps". Dieses Feld dient nur zur Fehlerbehebung. Sein tatsächlicher Wert kann sich zukünftig ändern.

Code

Nur Ausgabe. Definiert den Ursachencode für den Fehler. Nächste ID: 45

Enums
CODE_UNSPECIFIED Es liegt kein Fehler vor.
OK Es liegt kein Fehler vor.
INTERNAL_ERROR Zeigt einen internen Serverfehler an. VERWENDEN SIE DIESEN FEHLERCODE NICHT, es sei denn, die Ursache ist wirklich unbekannt.
APPENGINE_API_BACKEND_ERROR Eine der Start-URLs ist eine App Engine-URL, aber wegen eines Back-End-Fehlers der App Engine API können die Scaneinstellungen nicht überprüft werden.
APPENGINE_API_NOT_ACCESSIBLE Eine der Start-URLs ist eine App Engine-URL, aber für die Überprüfung der Scaneinstellungen kann nicht auf die App Engine API zugegriffen werden.
APPENGINE_DEFAULT_HOST_MISSING Eine der Start-URLs ist eine App Engine-URL, aber der Standardhost von App Engine ist nicht festgelegt.
CANNOT_USE_GOOGLE_COM_ACCOUNT Für das Scannen können keine Google-Unternehmenskonten verwendet werden.
CANNOT_USE_OWNER_ACCOUNT Das Konto des Scan-Erstellers kann nicht zum Scannen verwendet werden.
COMPUTE_API_BACKEND_ERROR Dieser Scan betrifft Compute Engine, aber wegen eines Back-End-Fehlers der Compute Engine API können die Scaneinstellungen nicht überprüft werden.
COMPUTE_API_NOT_ACCESSIBLE Dieser Scan betrifft Compute Engine, aber für die Überprüfung der Scaneinstellungen kann nicht auf die Compute Engine API zugegriffen werden.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Die benutzerdefinierte Log-in-URL gehört nicht zum aktuellen Projekt.
CUSTOM_LOGIN_URL_MALFORMED Die benutzerdefinierte Log-in-URL ist fehlerhaft und kann nicht geparst werden.
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Die benutzerdefinierte Log-in-URL ist im DNS einer nicht routingfähigen IP-Adresse zugeordnet.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS Die benutzerdefinierte Log-in-URL ist einer IP-Adresse zugeordnet, die nicht für das aktuelle Projekt reserviert ist.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS Die benutzerdefinierte Log-in-URL hat eine nicht routingfähige IP-Adresse.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS Die benutzerdefinierte Log-in-URL hat eine IP-Adresse, die nicht für das aktuelle Projekt reserviert ist.
DUPLICATE_SCAN_NAME Es ist bereits ein Scan mit diesem Namen vorhanden (Groß-/Kleinschreibung muss beachtet werden).
INVALID_FIELD_VALUE Ein Feld ist auf einen ungültigen Wert festgelegt.
FAILED_TO_AUTHENTICATE_TO_TARGET Beim Versuch, sich beim Scanziel zu authentifizieren, ist ein Fehler aufgetreten.
FINDING_TYPE_UNSPECIFIED In der Anfrage zur Auflistung der Ergebnisse ist der Ergebnistyp nicht angegeben.
FORBIDDEN_TO_SCAN_COMPUTE Der Scan betrifft Compute Engine, aber Google Compute Engine Scanning Alpha wurde kein Zugriff auf das aktuelle Projekt gewährt.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN Nutzer versucht, den verwalteten Scan zu aktualisieren
MALFORMED_FILTER Der angegebene Filter ist fehlerhaft. Er kann beispielsweise nicht geparst werden, hat keinen Filtertyp im Ausdruck oder derselbe Filtertyp tritt mehr als einmal auf.
MALFORMED_RESOURCE_NAME Der angegebene Ressourcenname ist fehlerhaft und kann nicht geparst werden.
PROJECT_INACTIVE Das aktuelle Projekt ist nicht aktiv.
REQUIRED_FIELD Ein erforderliches Feld ist nicht festgelegt.
RESOURCE_NAME_INCONSISTENT Die Projekt-ID, ScanConfig-ID, ScanRun-ID oder Ergebnis-ID stimmen im Ressourcennamen nicht überein.
SCAN_ALREADY_RUNNING Der Scan, der gestartet werden soll, wird bereits ausgeführt.
SCAN_NOT_RUNNING Der Scan, der gestoppt werden sollte, wird nicht ausgeführt.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Eine der Start-URLs gehört nicht zum aktuellen Projekt.
SEED_URL_MALFORMED Eine der Start-URLs ist fehlerhaft und kann nicht geparst werden.
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Eine der Start-URLs ist im DNS einer nicht routingfähigen IP-Adresse zugeordnet.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS Eine der Start-URLs ist einer IP-Adresse zugeordnet, die nicht für das aktuelle Projekt reserviert ist.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS Eine der Start-URLs hat eine nicht routingfähige IP-Adresse.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS Eine der Start-URLs hat eine IP-Adresse, die nicht für das aktuelle Projekt reserviert ist.
SERVICE_ACCOUNT_NOT_CONFIGURED Das Web Security Scanner-Dienstkonto für das Projekt ist nicht konfiguriert.
TOO_MANY_SCANS Ein Projekt hat die maximale Anzahl von Scans erreicht.
UNABLE_TO_RESOLVE_PROJECT_INFO Das Auflösen der Details des aktuellen Projekts schlägt fehl.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Ein oder mehrere Muster der schwarzen Liste hatten das falsche Format.
UNSUPPORTED_FILTER Der angegebene Filter wird nicht unterstützt.
UNSUPPORTED_FINDING_TYPE Der angegebene Ergebnistyp wird nicht unterstützt. Es konnten beispielsweise keine Ergebnisse des angegebenen Ergebnistyps bereitgestellt werden.
UNSUPPORTED_URL_SCHEME Das URL-Schema von einer oder mehreren angegebenen URLs wird nicht unterstützt.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND CAI kann keine Assets auflisten.

ScanRunWarningTrace

Nur Ausgabe. Definiert eine Warnungstrace-Meldung für einen ScanRun. Warnungstraces liefern Kunden nützliche Informationen und machen damit den Scan effektiver.

JSON-Darstellung 
{
  "code": enum (Code)
}
Felder
code

enum (Code)

Gibt den Warnungscode an.

Code

Nur Ausgabe. Definiert einen Warnungsmeldungscode. Nächste ID: 6

Enums
CODE_UNSPECIFIED Der Standardwert wird nie verwendet.
INSUFFICIENT_CRAWL_RESULTS Gibt an, dass beim Scan eine unerwartet geringe Anzahl von URLs gefunden wurde. Mögliche Gründe dafür sind komplexe Navigationsfunktionen oder die Verwendung einer einzigen URL für viele verschiedene Seiten.
TOO_MANY_CRAWL_RESULTS Gibt an, dass beim Scan zu viele URLs für den Test oder zu viele redundante URLs gefunden wurden.
TOO_MANY_FUZZ_TASKS Gibt an, dass für den Scan zu viele Tests generiert wurden. Der Kunde sollte versuchen, die Anzahl der Start-URLs zu reduzieren, die QPS-Rate zu erhöhen oder den Umfang des Scans anhand der ausgeschlossenen Muster zu reduzieren.
BLOCKED_BY_IAP Gibt an, dass ein Scan von IAP blockiert wird.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Gibt an, dass für einen Scan kein Seed gefunden wurde

Methoden

get

 Ruft einen ScanRun ab.

list

 Listet ScanRuns unter einer bestimmten ScanConfig in absteigender Reihenfolge des ScanRun-Beendigungszeitpunkts auf.

stop

 Hält einen ScanRun an.