REST Resource: projects.scanConfigs.scanRuns

Recurso: ScanRun

Um ScanRun é um recurso somente de saída que representa uma execução real da verificação. Próximo ID: 12

Representação 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

Apenas saída. O nome do recurso do ScanRun. O nome segue o formato de 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Os códigos ScanRun são gerados pelo sistema.
executionState

enum (ExecutionState)

Apenas saída. O estado de execução do ScanRun.
resultState

enum (ResultState)

Apenas saída. O estado do resultado de ScanRun. Este campo está disponível somente após o estado de execução atingir "FINISHED".
startTime

string (Timestamp format)

Apenas saída. A hora em que o ScanRun iniciou.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Apenas saída. A hora em que o ScanRun atingiu o estado de término, foi encerrado ou interrompido pelo usuário.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Apenas saída. O número de URLs rastreados durante este ScanRun. Se a verificação estiver em andamento, o valor representa o número de URLs rastreados até o momento.
urlsTestedCount

string (int64 format)

Apenas saída. O número de URLs testados durante este ScanRun. Se a verificação estiver em andamento, o valor representa o número de URLs testados até o momento. Em geral, o número de URLs testados é maior do que o de rastreados porque, normalmente, um URL rastreado é testado com vários payloads de teste.
hasVulnerabilities

boolean

Apenas saída. Se a execução da verificação encontrou alguma vulnerabilidade.
progressPercent

integer

Apenas saída. A porcentagem de conclusão total entre 0 e 100. Se a verificação estiver na fila, o valor será 0. Se a verificação estiver em execução, o valor varia de 0 a 100. Se a verificação estiver concluída, o valor será 100.
errorTrace

object (ScanRunErrorTrace)

Apenas saída. Se resultState for um ERRO, esse campo vai mostrar o motivo principal do encerramento da verificação e mais detalhes, se disponíveis.
warningTraces[]

object (ScanRunWarningTrace)

Apenas saída. Uma lista de avisos, se houver algum durante a execução da verificação.

ExecutionState

Tipos de estado de execução do ScanRun.

Enums
EXECUTION_STATE_UNSPECIFIED Representa um estado inválido causado por erro interno do servidor. Esse valor nunca pode ser retornado.
QUEUED A verificação está aguardando na fila.
SCANNING A verificação está em andamento.
FINISHED A verificação foi finalizada ou interrompida pelo usuário.

ResultState

Tipos de estado do resultado do ScanRun.

Enums
RESULT_STATE_UNSPECIFIED Valor padrão. Este valor é retornado quando ScanRun ainda não está concluído.
SUCCESS A verificação foi concluída sem erros.
ERROR A verificação foi concluída com erros.
KILLED A verificação foi finalizada pelo usuário.

ScanRunErrorTrace

Apenas saída. Define uma mensagem de rastreamento de erro para uma ScanRun.

Representação JSON 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Campos
code

enum (Code)

Apenas saída. Indica o código do motivo do erro.
scanConfigError

object (ScanConfigError)

Apenas saída. Se a verificação encontrar o erro SCAN_CONFIG_ISSUE, esse campo terá a mensagem de erro encontrada durante a validação da configuração da verificação que é realizada antes de cada execução da verificação.
mostCommonHttpErrorCode

integer

Apenas saída. Se o recurso de verificação encontrar TOO_MANY_HTTP_ERRORS, esse campo vai indicar o código de erro HTTP mais comum, se disponível. Por exemplo, se o código for 404, o recurso de verificação encontrou muitas respostas NOT_FOUND.

Código

Apenas saída. Define um código de motivo de erro. Próximo ID: 8

Enums
CODE_UNSPECIFIED O valor padrão nunca é usado.
INTERNAL_ERROR Indica que a execução da verificação falhou devido a um erro interno do servidor.
SCAN_CONFIG_ISSUE Indica um erro de configuração de verificação, geralmente devido a configurações de ScanConfig desatualizadas, como startingUrls ou a configuração de DNS.
AUTHENTICATION_CONFIG_ISSUE Indica um erro de autenticação, geralmente devido a configurações de autenticação de ScanConfig desatualizadas.
TIMED_OUT_WHILE_SCANNING Indica um tempo limite da operação de verificação, geralmente causado por um site muito grande.
TOO_MANY_REDIRECTS Indica que uma verificação encontrou redirecionamentos excessivos, para autenticação ou outra página fora do escopo da verificação.
TOO_MANY_HTTP_ERRORS Indica que uma verificação encontrou vários erros nas páginas do site. Quando disponível, o campo mostCommonHttpErrorCode indica o código de erro HTTP mais comum encontrado durante a verificação.
STARTING_URLS_CRAWL_HTTP_ERRORS Indica que alguns dos URLs da Web iniciais retornaram erros HTTP durante a verificação.

ScanConfigError

Define uma mensagem de erro personalizada usada pelas APIs CreateScanConfig e UpdateScanConfig quando a validação da configuração da verificação falha. Ele também é informado como parte de uma mensagem ScanRunErrorTrace se a validação da verificação falhar devido a um erro de configuração.

Representação JSON 
{
  "code": enum (Code),
  "fieldName": string
}
Campos
code

enum (Code)

Apenas saída. Indica o código do motivo de uma falha de configuração.
fieldName

string

Apenas saída. Indica o nome completo do campo ScanConfig que aciona esse erro, por exemplo, "scanConfig.max_qps". Esse campo é fornecido apenas para fins de solução de problemas, e o valor real pode mudar no futuro.

Código

Apenas saída. Define um código de motivo de erro. Próximo ID: 45

Enums
CODE_UNSPECIFIED Não há erro.
OK Não há erro.
INTERNAL_ERROR Indica um erro interno do servidor. NÃO USE ESTE CÓDIGO DE ERRO, a menos que a causa raiz seja realmente desconhecida.
APPENGINE_API_BACKEND_ERROR Um dos URLs de semente é um URL do App Engine, mas não é possível validar as configurações de verificação devido a um erro de back-end da API do App Engine.
APPENGINE_API_NOT_ACCESSIBLE Um dos URLs de semente é um URL do App Engine, mas não podemos acessar a API do App Engine para validar as configurações da verificação.
APPENGINE_DEFAULT_HOST_MISSING Um dos URLs de semente é um URL do App Engine, mas o host padrão do App Engine não está definido.
CANNOT_USE_GOOGLE_COM_ACCOUNT As contas corporativas do Google não podem ser usadas para a verificação.
CANNOT_USE_OWNER_ACCOUNT A conta do criador da verificação não pode ser usada para fazer verificações.
COMPUTE_API_BACKEND_ERROR Essa verificação é destinada ao Compute Engine, mas não é possível validar as configurações devido a um erro no back-end da API Compute Engine.
COMPUTE_API_NOT_ACCESSIBLE Esta verificação é destinada ao Compute Engine, mas não podemos acessar a API Compute Engine para validar as configurações da verificação.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT O URL de login personalizado não pertence ao projeto atual.
CUSTOM_LOGIN_URL_MALFORMED O URL de login personalizado está corrompido (não pode ser analisado).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS O URL de login personalizado é mapeado para um endereço IP não roteável no DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS O URL de login personalizado está mapeado para um endereço IP que não está reservado para o projeto atual.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS O URL de login personalizado tem um endereço IP não roteável.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS O URL de login personalizado tem um endereço IP que não está reservado para o projeto atual.
DUPLICATE_SCAN_NAME Já existe outra verificação com o mesmo nome (sensível a maiúsculas e minúsculas).
INVALID_FIELD_VALUE Um campo está definido como um valor inválido.
FAILED_TO_AUTHENTICATE_TO_TARGET Houve um erro ao tentar autenticar no destino da verificação.
FINDING_TYPE_UNSPECIFIED O valor do tipo de descoberta não foi especificado na solicitação de descobertas da lista.
FORBIDDEN_TO_SCAN_COMPUTE A verificação de destino é o Compute Engine, mas o projeto atual não foi incluído na lista de permissões para o acesso Alfa à verificação do Google Compute Engine.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN O usuário tenta atualizar a verificação gerenciada
MALFORMED_FILTER O filtro fornecido está incorreto. Por exemplo, não pode ser analisado, não tem um tipo de filtro na expressão ou o mesmo tipo de filtro aparece mais de uma vez.
MALFORMED_RESOURCE_NAME O nome do recurso fornecido está incorreto (não pode ser analisado).
PROJECT_INACTIVE O projeto atual não está em um estado ativo.
REQUIRED_FIELD Um campo obrigatório não foi definido.
RESOURCE_NAME_INCONSISTENT O ID do projeto, o ID do scanconfig, o ID da verificação ou o ID da descoberta não são consistentes entre si no nome do recurso.
SCAN_ALREADY_RUNNING A verificação que está sendo solicitada para iniciar já está em execução.
SCAN_NOT_RUNNING A verificação que foi solicitada para ser interrompida não está em execução.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Um dos URLs de semente não pertence ao projeto atual.
SEED_URL_MALFORMED Um dos URLs de semente está malformado (não pode ser analisado).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Um dos URLs de semente é mapeado para um endereço IP não roteável no DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS Um dos URLs de semente está mapeado para um endereço IP que não está reservado para o projeto atual.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS Um dos URLs de semente tem um endereço IP roteável.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS Um dos URLs de semente tem um endereço IP que não está reservado para o projeto atual.
SERVICE_ACCOUNT_NOT_CONFIGURED A conta de serviço do Web Security Scanner não está configurada no projeto.
TOO_MANY_SCANS Um projeto atingiu o número máximo de verificações.
UNABLE_TO_RESOLVE_PROJECT_INFO Não é possível resolver os detalhes do projeto atual.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Um ou mais padrões da lista de bloqueio estavam no formato errado.
UNSUPPORTED_FILTER O filtro fornecido não é compatível.
UNSUPPORTED_FINDING_TYPE O tipo de descoberta fornecido não é aceito. Por exemplo, não fornecemos descobertas do tipo indicado.
UNSUPPORTED_URL_SCHEME O esquema de um ou mais dos URLs fornecidos não é aceito.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND O CAI não consegue listar recursos.

ScanRunWarningTrace

Apenas saída. Define uma mensagem de rastreamento de aviso para o ScanRun. Os rastros de aviso fornecem aos clientes informações úteis que ajudam a tornar o processo de verificação mais eficaz.

Representação JSON 
{
  "code": enum (Code)
}
Campos
code

enum (Code)

Apenas saída. Indica o código de aviso.

Código

Apenas saída. Define um código de mensagem de aviso. Próximo ID: 6

Enums
CODE_UNSPECIFIED O valor padrão nunca é usado.
INSUFFICIENT_CRAWL_RESULTS Indica que uma verificação descobriu um número inesperadamente baixo de URLs. Isso às vezes é causado por recursos de navegação complexos ou pelo uso de um único URL para várias páginas.
TOO_MANY_CRAWL_RESULTS Indica que uma verificação descobriu muitos URLs a serem testados ou URLs redundantes em excesso.
TOO_MANY_FUZZ_TASKS Indica que muitos testes foram gerados para a verificação. O cliente precisa reduzir o número de URLs iniciais, aumentar a taxa de QPS ou restringir o escopo da verificação usando os padrões excluídos.
BLOCKED_BY_IAP Indica que uma verificação está bloqueada pelo IAP.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Indica que nenhuma semente foi encontrada para uma verificação

Métodos

get

 Recebe um ScanRun.

list

 Lista ScanRuns em um determinado ScanConfig, em ordem decrescente de horário de término do ScanRun.

stop

 Interrompe um ScanRun.