Receber o status de uma auditoria

Nesta página, descrevemos como conferir o status de uma auditoria em andamento iniciada com o Audit Manager ou o Compliance Manager. As auditorias são operações de longa duração, e pode ser útil receber o status de uma auditoria enquanto a operação está em execução.

Antes de começar

Receber o status de uma auditoria em andamento

Console

  1. No console Google Cloud , acesse a página Ver auditorias.

    Acessar "Ver auditorias"

  2. Na página Ver avaliações, você pode conferir o status atual de uma auditoria em andamento ou mais informações sobre uma auditoria concluída.

  3. Para mais informações sobre a auditoria, clique no link na coluna Status.

gcloud

O comando gcloud audit-manager operations describe descreve uma operação de auditoria.

Antes de usar os dados do comando abaixo, faça estas substituições:

  • RESOURCE_TYPE: o tipo de recurso, um projeto ou uma pasta. Por exemplo, folders ou projects.
  • RESOURCE_ID: o ID do recurso do projeto ou da pasta. Por exemplo, 8767234.
  • LOCATION: o local do endpoint de API Audit Manager. Para conferir uma lista de endpoints disponíveis, consulte Locais do Audit Manager. Por exemplo: us-central1.
  • AUDIT_OPERATION_ID: o ID exclusivo da operação em andamento incluída no corpo da resposta quando você executou a auditoria. Por exemplo: 098234.

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud audit-manager operations describe AUDIT_OPERATION_ID \
    --RESOURCE_TYPE=RESOURCE_ID \
    --location=LOCATION

Windows (PowerShell)

gcloud audit-manager operations describe AUDIT_OPERATION_ID `
    --RESOURCE_TYPE=RESOURCE_ID `
    --location=LOCATION

Windows (cmd.exe)

gcloud audit-manager operations describe AUDIT_OPERATION_ID ^
    --RESOURCE_TYPE=RESOURCE_ID ^
    --location=LOCATION

Uma resposta bem-sucedida inclui um dos seguintes tipos de status de execução:

Tipo de status Descrição
OPERATION_STATE_UNSPECIFIED Um estado inválido.
OPERATION_STATE_NOT_STARTED O processo de geração do relatório de auditoria ainda não começou.
OPERATION_STATE_EVALUATION_IN_PROGRESS O Audit Manager está avaliando os recursos em relação aos controles de compliance.
OPERATION_STATE_EVALUATION_DONE O Audit Manager concluiu a avaliação de compliance.
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_IN_PROGRESS O Audit Manager está criando um relatório de auditoria com base nos dados avaliados.
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_DONE O Audit Manager concluiu a geração do relatório de auditoria.
OPERATION_STATE_EVIDENCE_UPLOAD_IN_PROGRESS O Audit Manager está fazendo upload do relatório e das evidências de auditoria para o destino.
OPERATION_STATE_DONE O processo de geração do relatório de auditoria é concluído.
OPERATION_STATE_FAILED O processo de geração do relatório de auditoria falhou.

Cada um dos tipos de status de execução pode fornecer as seguintes informações adicionais, quando aplicável:

Status adicional Descrição
failure_reason Se a avaliação de auditoria falhar, esse campo vai mostrar o motivo.
evaluation_percent_complete Se a avaliação tiver começado, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.
report_generation_percent_complete Se a geração do relatório tiver sido iniciada, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.
report_uploading_percent_complete Se o upload do relatório tiver começado, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.

Uma resposta bem-sucedida da gcloud é semelhante a esta:

done: true
name: projects/PROJECT_ID/locations/LOCATION/operationDetails/AUDIT_OPERATION_ID
response:
  '@type': type.googleapis.com/google.cloud.auditmanager.v1.AuditReport
  gcsUri: gs://testbucketauditmanager

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • RESOURCE_TYPE: o tipo de recurso, um projeto ou uma pasta. Por exemplo, folders ou projects.
  • RESOURCE_ID: o ID do recurso do projeto ou da pasta. Por exemplo, 8767234.
  • LOCATION: o local do endpoint de API Audit Manager. Para conferir uma lista de endpoints disponíveis, consulte Locais do Audit Manager. Por exemplo: us-central1.
  • AUDIT_OPERATION_ID: o ID exclusivo da operação em andamento incluída no corpo da resposta quando você executou a auditoria. Por exemplo: 098234.

Método HTTP e URL: 

GET https://auditmanager.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/locations/LOCATION//operationDetails/AUDIT_OPERATION_ID

Para enviar a solicitação, escolha uma destas opções:

curl

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://auditmanager.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/locations/LOCATION//operationDetails/AUDIT_OPERATION_ID"

PowerShell

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://auditmanager.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/locations/LOCATION//operationDetails/AUDIT_OPERATION_ID" | Select-Object -Expand Content

Uma resposta bem-sucedida inclui um dos seguintes tipos de status de execução:

Tipo de status Descrição
OPERATION_STATE_UNSPECIFIED Um estado inválido.
OPERATION_STATE_NOT_STARTED O processo de geração do relatório de auditoria ainda não começou.
OPERATION_STATE_EVALUATION_IN_PROGRESS O Audit Manager está avaliando os recursos em relação aos controles de compliance.
OPERATION_STATE_EVALUATION_DONE O Audit Manager concluiu a avaliação de compliance.
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_IN_PROGRESS O Audit Manager está criando um relatório de auditoria com base nos dados avaliados.
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_DONE O Audit Manager concluiu a geração do relatório de auditoria.
OPERATION_STATE_EVIDENCE_UPLOAD_IN_PROGRESS O Audit Manager está fazendo upload do relatório e das evidências de auditoria para o destino.
OPERATION_STATE_DONE O processo de geração do relatório de auditoria é concluído.
OPERATION_STATE_FAILED O processo de geração do relatório de auditoria falhou.

Cada um dos tipos de status de execução pode fornecer as seguintes informações adicionais, quando aplicável:

Status adicional Descrição
failure_reason Se a avaliação de auditoria falhar, esse campo vai mostrar o motivo.
evaluation_percent_complete Se a avaliação tiver começado, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.
report_generation_percent_complete Se a geração do relatório tiver sido iniciada, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.
report_uploading_percent_complete Se o upload do relatório tiver começado, esse campo vai mostrar a porcentagem do progresso. Quando o processo ainda não começou, o campo começa em 0. Quando o processo é concluído, o campo é definido como 100.

Uma resposta REST bem-sucedida é semelhante a esta:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operationDetails/AUDIT_OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.auditmanager.v1.AuditReport",
    "gcsUri": "gs://testbucketauditmanager"
  }
}

Quando um relatório de auditoria é concluído e enviado, um link para ele é retornado.

A seguir