Vorfallberichte abrufen

Vorschau

Dieses Produkt oder diese Funktion unterliegt den Bedingungen für Pre‑GA-Angebote im Abschnitt „Allgemeine Dienstbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Produkte und ‑Funktionen stehen in der vorliegenden Form zur Verfügung und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie in den Beschreibungen der Produkteinführungsphasen.

In diesem Dokument wird beschrieben, wie Sie den Vorfallbericht für einen Google Cloud-Vorfall mit der Service Health API abrufen.

Vorfallberichte sind für Vorfälle verfügbar, die die folgenden Bedingungen erfüllen:

• Der Vorfall hat globale Auswirkungen oder betrifft einen erheblichen Prozentsatz der Kundenprojekte in einer oder mehreren Regionen.
• Mindestens ein Produkt ist nicht verfügbar oder stark beeinträchtigt.
• Sie haben die Service Health API 24 Stunden vor Beginn des Vorfalls aktiviert.

Hinweis

• Berechtigungen für den Zugriff auf die Service Health API festlegen
• Rufen Sie die Ereignis-ID des Vorfalls ab, für den Sie einen Vorfallsbericht prüfen möchten. Sie können eine Liste der geschlossenen Vorfälle aufrufen und die ID des Vorfalls suchen.

ID für den Vorfallbericht abrufen

So rufen Sie den Vorfallbericht für einen Vorfall ab:

1. Details zum Vorfall abrufen

2. Suchen Sie in der JSON-Antwort nach der folgenden Zeile:

   "artifact": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
   

3. Notieren Sie sich die ARTIFACT_ID.

Inhalt des Vorfallberichts abrufen

Mit der Get API können Sie den Inhalt des Vorfallberichts abrufen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

• PROJECT_ID ist Ihre Google Cloud-Projekt-ID.
• ARTIFACT_ID: die ID des Vorfallberichts.

HTTP-Methode und URL:

GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

curl (Linux, macOS oder Cloud Shell)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt oder die Cloud Shell genutzt haben, die Sie automatisch in der gcloud-Befehlszeile anmeldet. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID"

PowerShell (Windows)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt haben. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID" | Select-Object -Expand Content

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "name": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
  "content": {
      "markdown": "Content of the incident report.",
    },
  "category": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
  "createTime": "2022-10-18T18:00:05.690761Z",
  "updateTime": "2022-10-18T17:41:20.112287Z",
}

Wenn Sie nicht die Berechtigungen zum Abrufen von Vorfallberichten haben, wird der folgende PERMISSION_DENIED-Fehler angezeigt.

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.artifacts.get' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_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/artifacts/ARTIFACT_ID",
          "permission": "servicehealth.artifacts.get"
        }
      }
    ]
  }
}

Um den Fehler zu beheben, legen Sie die erforderlichen Berechtigungen fest.

Liste der Vorfallberichte abrufen

Mit der Methode ListArtifacts können Sie eine Liste von Vorfallberichten abrufen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

• PROJECT_ID ist Ihre Google Cloud-Projekt-ID.

HTTP-Methode und URL:

GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

curl (Linux, macOS oder Cloud Shell)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt oder die Cloud Shell genutzt haben, die Sie automatisch in der gcloud-Befehlszeile anmeldet. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts"

PowerShell (Windows)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt haben. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/artifacts" | Select-Object -Expand Content

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "artifacts": [
    {
      "name": "projects/PROJECT_ID/locations/global/artifacts/b2a4600f-33fb-4d33-a3ad-f43c8b8f2a3a",
      "content": {
          "markdown": "Content of the incident report.",
        },
      "category": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
      "createTime": "2022-10-18T17:41:20.112287Z",
      "updateTime": "2022-10-18T18:00:05.690761Z",
    }
  ],
  "nextPageToken": "ABCREGI=",
  "unreachable": []
}