REST Resource: projects.scanConfigs.scanRuns

Recurso: ScanRun

Un ScanRun es un recurso de solo salida que representa una ejecución real del análisis. ID siguiente: 12

Representación 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)
    }
  ]
}
Campos
name

string

Solo salida. Es el nombre del recurso de ScanRun. El nombre sigue el formato "projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}". El sistema genera los IDs de ScanRun.
executionState

enum (ExecutionState)

Solo salida. Es el estado de ejecución de ScanRun.
resultState

enum (ResultState)

Solo salida. El estado del resultado de ScanRun. Este campo solo está disponible después de que el estado de ejecución alcanza "FINALIZADA".
startTime

string (Timestamp format)

Solo salida. Es la hora en que comenzó ScanRun.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Solo salida. Es la hora en la que ScanRun alcanzó el estado de finalización, es decir, que el usuario finalizó o detuvo ScanRun.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Solo salida. Es la cantidad de URLs rastreadas durante esta ejecución de análisis. Si el análisis está en curso, el valor representa la cantidad de URLs rastreadas hasta el momento.
urlsTestedCount

string (int64 format)

Solo salida. Es la cantidad de URLs que se probaron durante esta ejecución de análisis. Si el análisis está en curso, el valor representa la cantidad de URLs que se probaron hasta el momento. Por lo general, la cantidad de URLs probadas es mayor que la cantidad de URLs rastreadas, ya que, por lo general, una URL rastreada se prueba con varias cargas útiles de prueba.
hasVulnerabilities

boolean

Solo salida. Si el análisis ejecutado encontró alguna vulnerabilidad.
progressPercent

integer

Solo salida. Es el porcentaje de finalización total que oscila entre 0 y 100. Si el análisis está en cola, el valor es 0. Si el análisis se está ejecutando, el valor varía de 0 a 100. Si el análisis finalizó, el valor es 100.
errorTrace

object (ScanRunErrorTrace)

Solo salida. Si resultState es un ERROR, este campo proporciona el motivo principal de la finalización del análisis y más detalles, si están disponibles.
warningTraces[]

object (ScanRunWarningTrace)

Solo salida. Es una lista de advertencias, si se encuentran durante esta ejecución de análisis.

ExecutionState

Tipos de estado de ejecución de ScanRun.

Enums
EXECUTION_STATE_UNSPECIFIED Representa un estado no válido causado por un error interno del servidor. Nunca debería mostrarse este valor.
QUEUED El análisis está esperando en la cola.
SCANNING El análisis está en curso.
FINISHED El usuario finaliza o detiene el análisis.

ResultState

Tipos de estado de resultado de ScanRun.

Enums
RESULT_STATE_UNSPECIFIED Valor predeterminado Este valor se muestra cuando ScanRun aún no finaliza.
SUCCESS El análisis finalizó sin errores.
ERROR El análisis finalizó con errores.
KILLED El usuario finalizó el análisis.

ScanRunErrorTrace

Solo salida. Define un mensaje de seguimiento de errores para un ScanRun.

Representación JSON 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Campos
code

enum (Code)

Solo salida. Indica el código de motivo del error.
scanConfigError

object (ScanConfigError)

Solo salida. Si el análisis encuentra el error SCAN_CONFIG_ISSUE, este campo tiene el mensaje de error que se encontró durante la validación de la configuración de análisis que se realiza antes de cada ejecución de análisis.
mostCommonHttpErrorCode

integer

Solo salida. Si el análisis encuentra TOO_MANY_HTTP_ERRORS, este campo indica el código de error HTTP más común, si está disponible. Por ejemplo, si este código es 404, el análisis encontró demasiadas respuestas NOT_FOUND.

Código

Solo salida. Define un código de motivo de error. ID siguiente: 8

Enums
CODE_UNSPECIFIED El valor predeterminado nunca se usa.
INTERNAL_ERROR Indica que la ejecución de la búsqueda falló debido a un error interno del servidor.
SCAN_CONFIG_ISSUE Indica un error de configuración de análisis, generalmente debido a parámetros de configuración de ScanConfig desactualizados, como startingUrls o la configuración de DNS.
AUTHENTICATION_CONFIG_ISSUE Indica un error de autenticación, por lo general, debido a una configuración de autenticación de ScanConfig desactualizada.
TIMED_OUT_WHILE_SCANNING Indica que se agotó el tiempo de espera de la operación de análisis, lo que suele deberse a que el sitio es muy grande.
TOO_MANY_REDIRECTS Indica que un análisis encontró redireccionamientos excesivos, ya sea a la autenticación o a alguna otra página fuera del alcance del análisis.
TOO_MANY_HTTP_ERRORS Indica que un análisis encontró varios errores en las páginas del sitio web. Cuando está disponible, el campo mostCommonHttpErrorCode indica el código de error HTTP más común que se encontró durante el análisis.
STARTING_URLS_CRAWL_HTTP_ERRORS Indica que algunas de las URLs web de partida mostraron errores HTTP durante el análisis.

ScanConfigError

Define un mensaje de error personalizado que usan las APIs de CreateScanConfig y UpdateScanConfig cuando falla la validación de la configuración de análisis. También se informa como parte de un mensaje ScanRunErrorTrace si la validación del análisis falla debido a un error de configuración del análisis.

Representación JSON 
{
  "code": enum (Code),
  "fieldName": string
}
Campos
code

enum (Code)

Solo salida. Indica el código de motivo de un error de configuración.
fieldName

string

Solo salida. Indica el nombre completo del campo ScanConfig que activa este error, por ejemplo, "scanConfig.max_qps". Este campo se proporciona solo para solucionar problemas, y su valor real puede cambiar en el futuro.

Código

Solo salida. Define un código de motivo de error. ID siguiente: 45

Enums
CODE_UNSPECIFIED No hay errores.
OK No hay errores.
INTERNAL_ERROR Indica que se produjo un error interno del servidor. NO UTILICES ESTE CÓDIGO DE ERROR, a menos que la causa raíz sea realmente desconocida.
APPENGINE_API_BACKEND_ERROR Una de las URLs de origen es una URL de App Engine, pero no podemos validar la configuración de análisis debido a un error de backend de la API de App Engine.
APPENGINE_API_NOT_ACCESSIBLE Una de las URLs de origen es una URL de App Engine, pero no podemos acceder a la API de App Engine para validar la configuración del análisis.
APPENGINE_DEFAULT_HOST_MISSING Una de las URLs de origen es una URL de App Engine, pero no se configuró el host predeterminado de App Engine.
CANNOT_USE_GOOGLE_COM_ACCOUNT No se pueden usar cuentas corporativas de Google para realizar análisis.
CANNOT_USE_OWNER_ACCOUNT No se puede usar la cuenta del creador del análisis para realizar análisis.
COMPUTE_API_BACKEND_ERROR Este análisis se orienta a Compute Engine, pero no podemos validar la configuración del análisis debido a un error del backend de la API de Compute Engine.
COMPUTE_API_NOT_ACCESSIBLE Este análisis se orienta a Compute Engine, pero no podemos acceder a la API de Compute Engine para validar la configuración del análisis.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT La URL de acceso personalizada no pertenece al proyecto actual.
CUSTOM_LOGIN_URL_MALFORMED La URL de acceso personalizada tiene un formato incorrecto (no se puede analizar).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS La URL de acceso personalizada está asignada a una dirección IP que no se puede enrutar en el DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS La URL de acceso personalizada está asignada a una dirección IP que no está reservada para el proyecto actual.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS La URL de acceso personalizada tiene una dirección IP que no se puede enrutar.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS La URL de acceso personalizada tiene una dirección IP que no está reservada para el proyecto actual.
DUPLICATE_SCAN_NAME Ya existe otro análisis con el mismo nombre (se distingue mayúsculas de minúsculas).
INVALID_FIELD_VALUE Un campo tiene un valor no válido.
FAILED_TO_AUTHENTICATE_TO_TARGET Se produjo un error al intentar autenticarse en el objetivo de análisis.
FINDING_TYPE_UNSPECIFIED El valor del tipo de resultado no se especifica en la solicitud de lista de resultados.
FORBIDDEN_TO_SCAN_COMPUTE El análisis se orienta a Compute Engine, pero el proyecto actual no se incluyó en la lista de entidades permitidas para el acceso a la versión alfa de Google Compute Engine Scanning.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN El usuario intenta actualizar la búsqueda administrada
MALFORMED_FILTER El filtro proporcionado tiene un formato incorrecto. Por ejemplo, no se puede analizar, no tiene un tipo de filtro en la expresión o el mismo tipo de filtro aparece más de una vez.
MALFORMED_RESOURCE_NAME El nombre del recurso proporcionado tiene un formato incorrecto (no se puede analizar).
PROJECT_INACTIVE El proyecto actual no está activo.
REQUIRED_FIELD No se estableció un campo obligatorio.
RESOURCE_NAME_INCONSISTENT El ID del proyecto, el ID de scanconfig, el ID de scanrun o el ID de hallazgo no son coherentes entre sí en el nombre del recurso.
SCAN_ALREADY_RUNNING El análisis que se solicita iniciar ya está en ejecución.
SCAN_NOT_RUNNING No se está ejecutando el análisis que se solicitó detener.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Una de las URLs de origen no pertenece al proyecto actual.
SEED_URL_MALFORMED Una de las URLs de origen tiene un formato incorrecto (no se puede analizar).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Una de las URLs de origen está asignada a una dirección IP que no se puede enrutar en el DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS Una de las URLs de origen está asignada a una dirección IP que no está reservada para el proyecto actual.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS Una de las URLs de origen tiene una dirección IP que se puede enrutar.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS Una de las URLs de origen tiene una dirección IP que no está reservada para el proyecto actual.
SERVICE_ACCOUNT_NOT_CONFIGURED La cuenta de servicio de Web Security Scanner no está configurada en el proyecto.
TOO_MANY_SCANS Un proyecto alcanzó la cantidad máxima de análisis.
UNABLE_TO_RESOLVE_PROJECT_INFO No se pueden resolver los detalles del proyecto actual.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Uno o más patrones de la lista de entidades bloqueadas tenían el formato incorrecto.
UNSUPPORTED_FILTER No se admite el filtro proporcionado.
UNSUPPORTED_FINDING_TYPE No se admite el tipo de hallazgo proporcionado. Por ejemplo, no proporcionamos hallazgos del tipo de hallazgo determinado.
UNSUPPORTED_URL_SCHEME No se admite el esquema de URL de una o más de las URLs proporcionadas.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND CAI no puede enumerar los recursos.

ScanRunWarningTrace

Solo salida. Define un mensaje de registro de advertencia para ScanRun. Los seguimientos de advertencia proporcionan a los clientes información útil que ayuda a que el proceso de análisis sea más eficaz.

Representación JSON 
{
  "code": enum (Code)
}
Campos
code

enum (Code)

Solo salida. Indica el código de advertencia.

Código

Solo salida. Define un código de mensaje de advertencia. ID siguiente: 6

Enums
CODE_UNSPECIFIED El valor predeterminado nunca se usa.
INSUFFICIENT_CRAWL_RESULTS Indica que un análisis detectó una cantidad inusualmente baja de URLs. Esto puede deberse a funciones de navegación complejas o al uso de una única URL para varias páginas.
TOO_MANY_CRAWL_RESULTS Indica que un análisis descubrió demasiadas URLs para probar o demasiadas URLs redundantes.
TOO_MANY_FUZZ_TASKS Indica que se generaron demasiadas pruebas para el análisis. El cliente debe intentar reducir la cantidad de URLs de inicio, aumentar la tasa de QPS o reducir el alcance del análisis con los patrones excluidos.
BLOCKED_BY_IAP Indica que IAP bloqueó un análisis.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Indica que no se encontraron semillas para un análisis

Métodos

get

 Obtiene un ScanRun.

list

 Enumera las ejecuciones de análisis de una ScanConfig determinada, en orden descendente según la hora de detención de la ejecución de análisis.

stop

 Detiene una ejecución de análisis.