Receba relatórios de incidentes

Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Este documento explica como obter o relatório de incidentes de um Google Cloud incidente através da API Service Health.

Os relatórios de incidentes estão disponíveis para incidentes que cumpram as seguintes condições:

• O incidente tem um impacto global ou está a afetar uma percentagem significativa de projetos de clientes numa ou mais regiões.
• Um ou mais produtos estão indisponíveis ou com um desempenho muito degradado.
• Vinte e quatro horas antes do início do incidente, ativou a API Service Health.

Antes de começar

• Defina autorizações para aceder à API Service Health.
• Obtenha o ID do evento do incidente para o qual quer verificar se existe um relatório de incidente. Pode aceder a uma lista de incidentes encerrados e encontrar o ID do incidente.

Obtenha o ID do relatório de incidente

Para obter o relatório de incidente de um incidente:

1. Obtenha os detalhes do incidente.

2. Procure a seguinte linha na resposta JSON:

   "artifact": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
   

3. Tenha em atenção o ARTIFACT_ID.

Obtenha o conteúdo do relatório de incidente

Pode usar a API Get para obter o conteúdo do relatório de incidentes.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

• PROJECT_ID: o ID do seu projeto do Google Cloud.
• ARTIFACT_ID: o ID do relatório de incidente.

Método HTTP e URL:

GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Nota: O comando seguinte pressupõe que tem sessão iniciada na CLI gcloud com a sua conta de utilizador executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que inicia automaticamente sessão na CLI gcloud. Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID"

PowerShell (Windows)

Nota: O comando seguinte pressupõe que iniciou sessão na CLI do Google Cloud com a sua conta de utilizador executando gcloud init ou gcloud auth login .gcloud Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Execute o seguinte comando:

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID" | Select-Object -Expand Content

Deve receber uma resposta JSON semelhante à seguinte:

{
  "name": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
  "content": {
      "markdown": "Content of the incident report.",
    },
  "category": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
  "createTime": "2022-10-18T18:00:05.690761Z",
  "updateTime": "2022-10-18T17:41:20.112287Z",
}

Se não tiver as autorizações para receber relatórios de incidentes, recebe o seguinte erro PERMISSION_DENIED.

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.artifacts.get' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID' (or it may not exist).",
    "status": "PERMISSION_DENIED",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "IAM_PERMISSION_DENIED",
        "domain": "servicehealth.googleapis.com",
        "metadata": {
          "resource": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
          "permission": "servicehealth.artifacts.get"
        }
      }
    ]
  }
}

Para corrigir o erro, defina as autorizações necessárias.