Ce document explique comment utiliser l'API Service Health pour gérer les événements affectant un seul projet.
Avant de commencer
Vérifiez que la facturation est activée pour votre projet Google Cloud .
- Activez l'API Service Health pour le projet dont vous souhaitez gérer les événements.
- Définissez les autorisations d'accès à l'API Service Health.
Références
Consultez la documentation de référence de l'API Events (v1, v1beta) pour connaître les méthodes que vous pouvez utiliser et la signification des champs dans les réponses.
Dans la réponse de l'API, chaque entrée de la liste impact inclut la perturbation précise state (AFFECTED ou RESOLVED), startTime et endTime (une fois résolue) pour chaque produit et emplacement concernés.
Lorsque vous définissez le produit ou l'emplacement, utilisez les valeurs disponibles dans Google Cloud products et locations.
Lister tous les incidents actifs d'un projet
Consultez le guide de démarrage rapide.
Obtenir les détails d'un incident
Vous pouvez utiliser l'API Get pour afficher des informations détaillées sur un événement.
Avant d'utiliser les données de requête, effectuez les remplacements suivants :
- API_VERSION : version de l'API à utiliser. Utilisez
v1ouv1beta. - PROJECT_ID : ID de votre projet Google Cloud.
- EVENT_ID : ID de l'événement.
Méthode HTTP et URL :
GET https://servicehealth.googleapis.com/API VERSION/projects/PROJECT_ID/locations/global/events/EVENT_ID
Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{
"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 vous ne disposez pas des autorisations nécessaires pour obtenir des événements, l'erreur PERMISSION_DENIED suivante s'affiche.
{
"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"
}
}
]
}
}
Pour corriger l'erreur, définissez les autorisations requises.
Lister les ressources concernées dans un projet
Pour les produits Google Cloud compatibles, vous pouvez lister les ressources Google Cloud spécifiques de votre projet qui sont affectées par un événement Personalized Service Health.
Pour lister les ressources concernées, l'API Service Health (servicehealth.googleapis.com) doit être activée sur le projet au moins 24 heures avant le début de l'événement, et votre compte principal doit disposer de l'autorisation servicehealth.impacts.list (incluse dans roles/servicehealth.viewer).
API REST (v1beta)
Pour lister les ressources concernées dans un projet, envoyez une requête à l'API Service Health avec les paramètres suivants :
| Paramètre | Valeur | Description |
|---|---|---|
parent |
projects/PROJECT_ID/locations/global |
Obligatoire. ID du projet ou numéro du projet pour lequel vous souhaitez lister les ressources concernées. |
pageSize |
1 à 100 | Facultatif. Nombre maximal d'impacts à renvoyer par page. Si cette valeur n'est pas spécifiée, elle est définie par défaut sur 10. |
pageToken |
string | Facultatif. Jeton d'un ListImpactsResponse précédent permettant de récupérer la page de résultats suivante. |
filter |
string | Facultatif. Expression de filtre pour limiter les impacts renvoyés. Par exemple, pour lister les ressources affectées par un événement spécifique, définissez filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID. |
Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :
PROJECT_ID: ID ou numéro de votre projet Google Cloud.
Méthode HTTP et URL :
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts
Pour utiliser curl, appelez directement le point de terminaison GET :
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
Exécutez la commande suivante pour lister les ressources concernées dans un projet :
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global
Pour lister uniquement les ressources affectées par un événement spécifique, transmettez l'option --filter :
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global \
--filter="events:projects/PROJECT_ID/locations/global/events/EVENT_ID"
Si la requête aboutit, le corps de la réponse contient une liste d'objets Impact semblable à celle-ci :
{
"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"
}
]
}
Exemples de filtres courants pour les ressources concernées
Vous pouvez transmettre un paramètre de requête filter (ou --filter dans la Google Cloud CLI) pour affiner les enregistrements Impact renvoyés :
- Répertorier les ressources concernées par un événement spécifique :
filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID - Répertorier les ressources concernées d'un type de ressource spécifique (par exemple, les instances Cloud SQL) :
filter=asset.assetType="sqladmin.googleapis.com/Instance" - Lister les ressources concernées mises à jour après un code temporel spécifique :
filter=updateTime>"2026-10-08T00:00:00Z"
Obtenir des détails sur une ressource concernée
Vous pouvez récupérer un enregistrement Impact spécifique à l'aide de son IMPACT_ID.
API REST (v1beta)
Pour obtenir des détails sur un enregistrement de ressource concerné spécifique, envoyez une requête avec le paramètre suivant :
| Paramètre | Valeur | Description |
|---|---|---|
name |
projects/PROJECT_ID/locations/global/impacts/IMPACT_ID |
Obligatoire. Nom complet de la ressource de l'enregistrement Impact à récupérer. |
Méthode HTTP et 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
Exécutez la commande suivante pour obtenir des détails sur un enregistrement de ressource concerné :
gcloud beta service-health impacts describe IMPACT_ID \
--project=PROJECT_ID \
--location=global
Si la requête aboutit, le corps de la réponse contient un objet 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"
}