In diesem Dokument wird beschrieben, wie Sie mit der Service Health API Ereignisse verwalten, die sich auf Ihre Organisation auswirken.
Personalized Service Health bietet die API-Ressourcen „OrganizationEvents“ und „OrganizationImpacts“, mit denen Sie Informationen zu Ereignissen abrufen können, die sich auf Ihre Organisation auswirken. Zu diesen Daten gehören:
- Service Health-Ereignisse, die sich auf ein oder mehrere Projekte in einer Organisation auswirken können.
- Liste der Projekte, die möglicherweise von einem Ereignis betroffen sind, das sich auf Ihre Organisation auswirkt.
Hinweise
- Aktivieren Sie die Service Health API für mindestens ein Projekt in Ihrer Organisation. Die API-Ressourcen „OrganizationEvents“ und „OrganizationImpacts“ rufen nur Informationen für Projekte ab, für die die Service Health API aktiviert ist.
-
Verify that billing is enabled for your Google Cloud project.
- Berechtigungen für den Zugriff auf die Service Health API festlegen
Konfigurieren Sie IAM-Berechtigungen (Identity and Access Management) für Ihre Organisation, um die API-Ressourcen „OrganizationEvents“ und „OrganizationImpacts“ zu verwenden. Führen Sie folgenden Befehl aus:
gcloud organizations add-iam-policy-binding $ORGANIZATION_ID \ --member {USER|GROUP|SERVICE_ACCOUNT} \ --role roles/servicehealth.viewerInformationen zum Abrufen Ihrer ORGANIZATION_ID finden Sie unter Organisationsressourcen-ID abrufen.
Die für eine Organisation gewährten IAM-Richtlinien werden von allen Projekten in der Organisation übernommen. Mit diesen Richtlinien können Sie auf Organisations- und Projektereignis-APIs in der gesamten Organisation zugreifen.
Verweise
In der API-Referenz für OrganizationEvents und OrganizationImpacts finden Sie Informationen zu den Methoden, die Sie verwenden können, und zur Bedeutung der Felder in der Antwort.
Verwenden Sie beim Festlegen des Produkts oder Standorts die Werte, die unter Google Cloud products und locations zu finden sind.
Projekte unter einer Organisation auflisten, die von einem Ereignis betroffen sein könnten
Weitere Informationen finden Sie in der Kurzanleitung.
Alle aktiven Vorfälle für eine Organisation auflisten
Weitere Informationen finden Sie in der Kurzanleitung.
Details zu einem Ereignis abrufen, das sich auf eine Organisation auswirkt
Mit der Get API können Sie detaillierte Informationen zu einem Ereignis abrufen, das sich auf eine Organisation auswirkt.
Ersetzen Sie diese Werte in den folgenden Anfragedaten:
- API_VERSION: Die zu verwendende API-Version. Verwenden Sie
v1oderv1beta. - ORGANIZATION_ID: Ihre Google Cloud-Organisations-ID.
- EVENT_ID: die ID des Ereignisses.
HTTP-Methode und URL:
GET https://servicehealth.googleapis.com/API VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:
{
"name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/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",
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "us-central1",
}
}
],
"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",
}
Wenn Sie keine Berechtigungen zum Abrufen von Ereignissen haben, erhalten Sie den folgenden PERMISSION_DENIED-Fehler.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.organizationEvents.get' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global/organizationEvents/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": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
"permission": "servicehealth.organizationEvents.get"
}
}
]
}
}
Um diesen Fehler zu beheben, müssen Sie die erforderlichen Berechtigungen festlegen.
Details zu einem Projekt in einer Organisation abrufen, das von einem Ereignis betroffen sein könnte
Die Ereignis-ID bleibt für ein bestimmtes Ereignis zwischen Ihren Projekt- und Organisationsereignissen gleich.
OrganizationImpact enthält ein EVENT_ID und ein PROJECT_NUMBER, mit denen Sie Details zu einem Ereignis abrufen können, das sich auf Ihr Projekt auswirkt. Zu diesen Details gehören state und relevance.
PROJECT_NUMBER ist austauschbar mit PROJECT_ID, das von der Get API zurückgegeben wird.