Ce document explique comment lister les événements Personalized Service Health qui peuvent avoir un impact ou qui ont eu un impact sur les produits Google Cloud de votre projet ou organisation Google Cloud . Vous allez utiliser l'API Personalized Service Health.
Avant de commencer
-
Activez l'API Service Health si ce n'est pas déjà fait :
Rôles requis pour activer les API
Pour activer des API, vous devez disposer de l'autorisation
serviceusage.services.enable. Si vous avez créé le projet, vous disposez probablement déjà de cette autorisation via le rôle Propriétaire (roles/owner). Sinon, vous pouvez l'obtenir via le rôle Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin). Découvrez comment attribuer des rôles.gcloud services enable servicehealth.googleapis.com
-
Vérifiez que la facturation est activée pour votre projet Google Cloud .
- Si vous utilisez un projet existant pour ce guide, vérifiez que vous disposez des autorisations nécessaires pour suivre les instructions. Si vous avez créé un projet, vous disposez déjà des autorisations requises.
Rôles requis
Pour obtenir les autorisations nécessaires pour lister les événements Service Health, demandez à votre administrateur de vous accorder le rôle IAM Lecteur Personalized Service Health (roles/servicehealth.viewer) sur le projet ou l'organisation pour lesquels vous souhaitez lister les événements.
Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.
Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.
Références
Consultez les documentations de référence des API Events (v1, v1beta), Impacts (v1beta), OrganizationEvents (v1, v1beta) et OrganizationImpacts (v1, v1beta) pour connaître les méthodes que vous pouvez utiliser et la signification des champs de la réponse.
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
Vous pouvez lister tous les incidents Google Cloud pour un projet Google Cloud spécifique.
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 du projet
Méthode HTTP et URL :
GET https://servicehealth.googleapis.com/API_VERSION/projects/PROJECT_ID/locations/global/events?filter=state=ACTIVE%20category=INCIDENT&page_size=2&page_token={page_token}Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{
"events": [
{
"name": "projects/PROJECT_ID/locations/global/events/event-123",
"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. We thank you for your patience while we worked on resolving the issue.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "ACTIVE",
"detailedState": "CONFIRMED",
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "asia-east2",
}
},
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "asia-southeast1",
}
}
],
"relevance": "RELATED",
"updateTime": "2022-10-18T17:44:05.690761Z",
"startTime": "2022-10-18T17:41:20.112287Z",
},
{
"name": "projects/PROJECT_ID/locations/global/events/event-567",
"title": "Cloud Firestore may experience errors.",
"description": "Mitigation work is currently underway by our engineering team. The mitigation is expected to complete by 2022-10-07T16:30:00Z.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "ACTIVE",
"detailedState": "CONFIRMED",
"eventImpacts": [
{
"product": {
"productName": "Cloud Firestore",
"id": "CETSkT92V21G6A1x28me",
},
"location": {
"locationName": "us-central1-a",
}
}
],
"relevance": "RELATED",
"updateTime": "2022-10-07T15:19:59.409530Z",
"startTime": "2022-10-07T15:10:35.887125Z",
"nextUpdateTime": "2022-10-07T16:30:00Z"
}
],
"nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}
Si vous ne disposez pas des autorisations requises pour lister les événements, vous obtiendrez une erreur PERMISSION_DENIED.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.events.list' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global' (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",
"permission": "servicehealth.events.list"
}
}
]
}
}
Lister tous les incidents actifs d'une organisation
Vous pouvez lister tous les incidents Google Cloud affectant un projet pour lequel Personalized Service Health est activé dans l'organisation Google Cloud spécifique.
Avant d'utiliser les données de requête, effectuez les remplacements suivants :
- API_VERSION : version de l'API à utiliser. Utilisez
v1ouv1beta. - ORGANIZATION_ID : ID d'organisation Google Cloud.
- PROJECT_ID : ID du projet utilisé pour les quotas et la facturation.
Méthode HTTP et URL :
GET https://servicehealth.googleapis.com/API_VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents?filter=state=ACTIVE%20category=INCIDENT&page_size=2&page_token={page_token}Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{
"organization_events": [
{
"name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/event-123",
"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. We thank you for your patience while we worked on resolving the issue.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "ACTIVE",
"detailedState": "CONFIRMED",
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "asia-east2",
}
},
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "asia-southeast1",
}
}
],
"updateTime": "2022-10-18T17:44:05.690761Z",
"startTime": "2022-10-18T17:41:20.112287Z",
},
{
"name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/event-567",
"title": "Cloud Firestore may experience errors.",
"description": "Mitigation work is currently underway by our engineering team. The mitigation is expected to complete by 2022-10-07T16:30:00Z.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "ACTIVE",
"detailedState": "CONFIRMED",
"eventImpacts": [
{
"product": {
"productName": "Cloud Firestore",
"id": "CETSkT92V21G6A1x28me",
},
"location": {
"locationName": "us-central1-a",
}
}
],
"updateTime": "2022-10-07T15:19:59.409530Z",
"startTime": "2022-10-07T15:10:35.887125Z",
"nextUpdateTime": "2022-10-07T16:30:00Z"
}
],
"nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}
Pour obtenir votre ORGANIZATION_ID, consultez Obtenir l'ID de ressource de votre organisation.
Si vous ne disposez pas des autorisations nécessaires pour lister les événements, vous obtiendrez une erreur PERMISSION_DENIED.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.organizationEvents.list' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global' (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": "organizations/<var class="readonly">ORGANIZATION_ID</var>/locations/global",
"permission": "servicehealth.organizationEvents.list"
}
}
]
}
}
Lister les projets d'une organisation susceptibles d'être affectés par un événement
Vous pouvez lister tous les projets d'une organisation Google Cloud spécifique qui :
- Peut être affecté par un événement (
OrganizationImpact). - avoir activé Personalized Service Health ;
Avant d'utiliser les données de requête, effectuez les remplacements suivants :
- API_VERSION : version de l'API à utiliser. Utilisez
v1ouv1beta. - EVENT_ID : ID de l'événement susceptible d'affecter une organisation.
- ORGANIZATION_ID : ID d'organisation Google Cloud.
- PROJECT_ID : ID du projet utilisé pour les quotas et la facturation.
Méthode HTTP et URL :
GET https://servicehealth.googleapis.com/API_VERSION/organizations/ORGANIZATION_ID/locations/global/organizationImpacts?filter=events:organizations%2FORGANIZATION_ID%2Flocations%2Fglobal%2FEVENT_ID&page_size=2&page_token={page_token}Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{
"organization_impacts": [
{
"name": "organizations/ORGANIZATION_ID/locations/global/organizationImpacts/impact-123",
"events": [
"organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
],
"asset": {
"assetName": "//cloudresourcemanager.googleapis.com/projects/{PROJECT_NUMBER_1}",
"assetType": "cloudresourcemanager.googleapis.com/Project",
},
"updateTime": "2022-10-18T17:44:05.690761Z",
},
{
"name": "organizations/ORGANIZATION_ID/locations/global/organizationImpacts/impact-234",
"events": [
"organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
],
"asset": {
"assetName": "//cloudresourcemanager.googleapis.com/projects/{PROJECT_NUMBER_2}",
"assetType": "cloudresourcemanager.googleapis.com/Project",
},
"updateTime": "2022-10-18T17:44:05.690761Z",
}
],
"nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}
Si vous ne disposez pas des autorisations nécessaires pour lister les événements, vous obtiendrez l'erreur PERMISSION_DENIED suivante.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.organizationImpacts.list' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global' (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": "organizations/ORGANIZATION_ID/locations/global",
"permission": "servicehealth.organizationImpacts.list"
}
}
]
}
}
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 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 :
- Lister 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"
}
Étapes suivantes
Découvrez comment extraire des informations sur les événements par projet ou par organisation à l'aide de l'API Service Health.