En este documento, se explica cómo usar la API de Service Health para administrar los eventos que afectan a un solo proyecto.
Antes de comenzar
Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .
- Habilita la API de Service Health para el proyecto en el que deseas administrar eventos.
- Establece permisos para acceder a la API de Service Health.
Referencias
Consulta la referencia de la API de Events (v1, v1beta)
para conocer los métodos que puedes usar y el significado de los campos en las respuestas.
En la respuesta de la API, cada entrada de la lista impact incluye la interrupción detallada state (AFFECTED o RESOLVED), startTime y endTime (cuando se resuelve) para cada producto y ubicación afectados.
Cuando configures el producto o la ubicación, usa los valores que se encuentran en Google Cloud products y locations.
Enumera todos los incidentes activos de un proyecto
Consulta la guía de inicio rápido.
Obtén detalles del incidente
Puedes usar la API de Get para ver información detallada sobre un evento.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- API_VERSION: La versión de la API que se usará. Usa
v1ov1beta - PROJECT_ID: tu ID del proyecto de Google Cloud.
- EVENT_ID: Es el ID del evento.
Método HTTP y URL:
GET https://servicehealth.googleapis.com/API VERSION/projects/PROJECT_ID/locations/global/events/EVENT_ID
Para enviar tu solicitud, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{
"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",
}
Si no tienes los
permisos para obtener eventos,
recibirás el siguiente error 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 corregir el error, configura los permisos necesarios.
Enumera los recursos afectados en un proyecto
Para los productos Google Cloud compatibles, puedes enumerar los recursos de Google Cloud específicos de tu proyecto que se ven afectados por un evento de Personalized Service Health.
Para enumerar los recursos afectados, la API de Service Health
(servicehealth.googleapis.com) debe estar habilitada en el proyecto al menos 24
horas antes de que comience el evento, y tu principal debe tener el
permiso servicehealth.impacts.list (incluido en
roles/servicehealth.viewer).
API de REST (v1beta)
Para enumerar los recursos afectados en un proyecto, envía una solicitud a la API de Service Health con los siguientes parámetros:
| Parámetro | Valor | Descripción |
|---|---|---|
parent |
projects/PROJECT_ID/locations/global |
Obligatorio. Es el ID del proyecto o el número del proyecto en el que deseas enumerar los recursos afectados. |
pageSize |
De 1 a 100 | Es opcional. Es la cantidad máxima de impactos que se devolverán por página. Cuando no se especifica, el valor predeterminado es 10. |
pageToken |
cadena | Es opcional. Es el token de un ListImpactsResponse anterior para recuperar la siguiente página de resultados. |
filter |
cadena | Es opcional. Es la expresión de filtro para definir el alcance de los impactos que se muestran. Por ejemplo, para enumerar los recursos afectados por un evento específico, establece filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID. |
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
PROJECT_ID: Es el ID o el número de tu proyecto de Google Cloud.
Método HTTP y URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts
Para usar curl, llama al extremo GET directamente:
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
Ejecuta el siguiente comando para enumerar los recursos afectados en un proyecto:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global
Para enumerar solo los recursos afectados por un evento específico, pasa la marca --filter:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global \
--filter="events:projects/PROJECT_ID/locations/global/events/EVENT_ID"
Si la solicitud se realiza correctamente, el cuerpo de la respuesta contendrá una lista de objetos Impact similar a la siguiente:
{
"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"
}
]
}
Ejemplos de filtros comunes para recursos afectados
Puedes pasar un parámetro de consulta filter (o --filter en Google Cloud CLI) para
reducir los registros Impact que se muestran:
- Enumera los recursos afectados por un evento específico:
filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID - Enumera los recursos afectados de un tipo de recurso específico (por ejemplo, instancias de Cloud SQL):
filter=asset.assetType="sqladmin.googleapis.com/Instance" - Enumera los recursos afectados que se actualizaron después de una marca de tiempo específica:
filter=updateTime>"2026-10-08T00:00:00Z"
Obtén detalles sobre un recurso afectado
Puedes recuperar un registro Impact específico con su IMPACT_ID.
API de REST (v1beta)
Para obtener detalles sobre un registro de recurso afectado específico, envía una solicitud con el siguiente parámetro:
| Parámetro | Valor | Descripción |
|---|---|---|
name |
projects/PROJECT_ID/locations/global/impacts/IMPACT_ID |
Obligatorio. Es el nombre completo del recurso del registro de Impact que se recuperará. |
Método HTTP y 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
Ejecuta el siguiente comando para obtener detalles sobre un registro de recursos afectado:
gcloud beta service-health impacts describe IMPACT_ID \
--project=PROJECT_ID \
--location=global
Si la solicitud se realiza correctamente, el cuerpo de la respuesta contendrá un 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"
}