取得事件報告

本文說明如何使用 Service Health API 取得事件的事件報告。 Google Cloud

事件報告適用於符合下列條件的事件:

  • 事件影響範圍遍及全球,或影響一或多個區域中相當比例的客戶專案。
  • 一或多項產品無法使用或嚴重降級。
  • 您已在事件開始前 24 小時啟用 Service Health API

事前準備

取得事件報告的 ID

如要取得事件的事件報告,請按照下列步驟操作:

  1. 取得事件詳細資料
  2. 在 JSON 回應中尋找下列程式碼:

    "artifact": "projects/PROJECT_ID/locations/global/artifacts/ARTIFACT_ID",
    
  3. 請注意 ARTIFACT_ID

取得事件報告內容

您可以使用 Get API 取得事件報告內容。

使用任何要求資料之前,請先替換以下項目:

  • PROJECT_ID:您的 Google Cloud 專案 ID。
  • ARTIFACT_ID:事件報告的 ID。

HTTP 方法和網址:

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

請展開以下其中一個選項,以傳送要求:

您應該會收到如下的 JSON 回覆:

{
  "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",
}

如果您沒有取得事件報告的權限,會收到下列 PERMISSION_DENIED 錯誤。

{
  "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"
        }
      }
    ]
  }
}

如要修正錯誤,請設定必要權限