インシデント レポートを取得する

プレビュー

このプロダクトまたは機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 一般提供前のプロダクトと機能は「現状のまま」ご利用いただけますが、サポートが制限される場合があります。 詳しくは、リリース ステージの説明をご覧ください。

このドキュメントでは、Service Health API を使用してインシデントのインシデント レポートを取得する方法について説明します。 Google Cloud

インシデント レポートは、次の条件を満たすインシデントに対して利用できます。

• インシデントがグローバルに与える影響、または 1 つ以上のリージョンでお客様のプロジェクトの大部分に影響していること。
• 1 つ以上のサービスが利用できないか、大幅に低下している。

始める前に

• Service Health API にアクセスするための権限を設定します。
• インシデント レポートを確認するインシデントのイベント ID を取得します。クローズされたインシデントのリストを取得して、インシデントの ID を確認できます。

インシデント レポートの 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 メソッドと URL:

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

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

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）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$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

次のような 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"
        }
      }
    ]
  }
}

このエラーを修正するには、必要な権限を設定します。