Receber relatórios de incidentes

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Este documento explica como receber o relatório de incidente de um Google Cloud incidente usando a API Service Health.

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

• O incidente tem impacto global ou está afetando uma porcentagem significativa de projetos de clientes em uma ou mais regiões.
• Um ou mais produtos estão indisponíveis ou com problemas graves.

Antes de começar

• Defina permissões para acessar a API Service Health.
• Acesse o ID do evento que você quer verificar se há um relatório de incidente. Você pode receber uma lista de incidentes fechados e encontrar o ID do incidente.

Conferir o ID do relatório de incidente

Para acessar o relatório de incidente:

1. Conferir os detalhes do incidente.

2. Procure a seguinte linha na resposta JSON:

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

3. Anote o ARTIFACT_ID.

Acessar o conteúdo do relatório de incidente

Você pode usar a API Get para acessar o conteúdo do relatório de incidentes.

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

• PROJECT_ID: é seu ID do projeto no 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 a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando 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)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando 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

Você receberá uma resposta JSON semelhante a esta:

{
  "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 você não tiver as permissões para receber relatórios de incidentes, vai receber 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 permissões necessárias.