Este documento explica as instruções para usar a API Service Health para gerenciar eventos que afetam um único projeto.
Antes de começar
Verifique se o faturamento está ativado para o projeto do Google Cloud .
- Ative a API Service Health no projeto em que você quer gerenciar eventos.
- Defina as permissões para acessar a API Service Health.
Referências
Consulte a referência da API Events (v1, v1beta)
para saber quais métodos podem ser usados e o significado dos campos nas respostas.
Na resposta da API, cada entrada na lista impact inclui a interrupção granular state (AFFECTED ou RESOLVED), startTime e endTime (quando resolvida) para cada produto e local afetados.
Ao definir o produto ou o local, use os valores encontrados em Google Cloud produtos e locais.
Listar todos os incidentes ativos de um projeto
Consulte o guia de início rápido.
Receber detalhes do incidente
Use a API Get para ver informações detalhadas sobre um evento.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- API_VERSION: a versão da API a ser usada. Use
v1ouv1beta. - PROJECT_ID: é seu ID do projeto no Google Cloud.
- EVENT_ID: o ID do evento.
Método HTTP e URL:
GET https://servicehealth.googleapis.com/API VERSION/projects/PROJECT_ID/locations/global/events/EVENT_ID
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"name": "projects/PROJECT_ID/locations/global/events/EVENT_ID",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific. We thank you for your patience while we worked on resolving the issue.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "CLOSED",
"detailedState": "RESOLVED",
"artifacts": [
{
"artifact": "projects/PROJECT_ID/locations/global/artifacts/artifact_id",
"artifactCategory": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
}
],
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "us-central1",
}
}
],
"relevance": "RELATED",
"updates": [
{
"updateTime": "2022-10-18T17:41:20.112287Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "We are experiencing an intermittent issue with Google Cloud SQL. Our engineering team continues to investigate the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
},
{
"updateTime": "2022-10-18T18:00:05.690761Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific.\n\nWe thank you for your patience while we worked on resolving the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
}
],
"updateTime": "2022-10-18T18:00:05.690761Z",
"startTime": "2022-10-18T17:41:20.112287Z",
"endTime": "2022-10-18T18:00:05.690761Z",
}
Se você não tiver as
permissões para receber eventos,
vai receber o seguinte erro PERMISSION_DENIED.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.events.get' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global/events/EVENT_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/events/EVENT_ID",
"permission": "servicehealth.events.get"
}
}
]
}
}
Para corrigir o erro, defina as permissões necessárias.
Listar recursos afetados em um projeto
Para produtos Google Cloud compatíveis, é possível listar os recursos específicos do Google Cloud no projeto que são afetados por um evento do Personalized Service Health.
Para listar os recursos afetados, a API Service Health
(servicehealth.googleapis.com) precisa estar ativada no projeto pelo menos 24
horas antes do início do evento, e o principal precisa ter a
permissão servicehealth.impacts.list (incluída em
roles/servicehealth.viewer).
API REST (v1beta)
Para listar os recursos afetados em um projeto, envie uma solicitação à API Service Health com os seguintes parâmetros:
| Parâmetro | Valor | Descrição |
|---|---|---|
parent |
projects/PROJECT_ID/locations/global |
Obrigatório. ID do projeto ou número do projeto em que você quer listar os recursos afetados. |
pageSize |
1 a 100 | Opcional. Número máximo de impactos a serem retornados por página. Quando não especificado, o padrão é 10. |
pageToken |
string | Opcional. Token de um ListImpactsResponse anterior para recuperar a próxima página de resultados. |
filter |
string | Opcional. Expressão de filtro para definir o escopo dos impactos retornados. Por exemplo, para listar recursos afetados por um evento específico, defina filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID. |
Antes de usar os dados da solicitação, faça as substituições a seguir:
PROJECT_ID: o ID ou número do projeto do Google Cloud.
Método HTTP e URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts
Para usar o curl, chame o endpoint GET diretamente:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts"
gcloud
Execute o seguinte comando para listar os recursos afetados em um projeto:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global
Para listar apenas os recursos afetados por um evento específico, transmita a flag --filter:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global \
--filter="events:projects/PROJECT_ID/locations/global/events/EVENT_ID"
Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma lista de objetos Impact semelhantes a esta:
{
"impacts": [
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}
]
}
Exemplos de filtros comuns para recursos afetados
É possível transmitir um parâmetro de consulta filter (ou --filter na Google Cloud CLI) para
restringir os registros Impact retornados:
- Listar recursos afetados por um evento específico:
filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID - Listar recursos afetados de um tipo específico (por exemplo, instâncias do Cloud SQL):
filter=asset.assetType="sqladmin.googleapis.com/Instance" - Listar os recursos afetados atualizados após um carimbo de data/hora específico:
filter=updateTime>"2026-10-08T00:00:00Z"
Receber detalhes sobre um recurso afetado
É possível recuperar um registro Impact específico usando o IMPACT_ID dele.
API REST (v1beta)
Para saber mais sobre um registro de recurso afetado específico, envie uma solicitação com o seguinte parâmetro:
| Parâmetro | Valor | Descrição |
|---|---|---|
name |
projects/PROJECT_ID/locations/global/impacts/IMPACT_ID |
Obrigatório. Nome completo do recurso do registro Impact a ser recuperado. |
Método HTTP e URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID"
gcloud
Execute o comando a seguir para ver detalhes sobre um registro de recurso afetado:
gcloud beta service-health impacts describe IMPACT_ID \
--project=PROJECT_ID \
--location=global
Se a solicitação for bem-sucedida, o corpo da resposta vai conter um objeto Impact:
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}