API を使用してリソースのメンテナンスを表示する

Unified Maintenance API を使用すると、リソースのメンテナンスに関する情報を返すことができます。

このドキュメントでは、Cloud Shell を使用して Unified Maintenance API を呼び出し、リソースのメンテナンスを返す方法について説明します。

Cloud Hub で今後のメンテナンス アクティビティと過去のメンテナンス アクティビティを表示するには、 メンテナンス アクティビティを表示するをご覧ください。

始める前に

Unified Maintenance を使用してリソースのメンテナンスを表示する前に、Unified Maintenance が リソースタイプをサポートしていることを確認してください。

App Hub アプリケーション (プレビュー) のメンテナンス アクティビティを表示するには、App Hub の既存の Google Cloud リソースからアプリケーションを定義するか、App Design Center で作成してデプロイする必要があります。

フィルタ

いくつかのパラメータを使用して、返されるメンテナンス アクティビティをフィルタできます。

  • 状態（SUCCEEDED、STARTED など）
  • リソース名
  • リソース ロケーション
  • リソースの種類
  • メンテナンス名
  • メンテナンス開始時刻
  • メンテナンス終了時刻

詳細については、 Unified Maintenance API のドキュメントをご覧ください。

リソースのメンテナンスを表示する

Unified Maintenance API を使用すると、 メンテナンス アクティビティ 情報を Google Cloud プロジェクトに返すことができます。フォルダレベルの境界でアプリケーションを 管理している場合は、フォルダの管理プロジェクトを使用します。

すべてのメンテナンス アクティビティを一覧表示するには:

  1. Cloud Shell に移動します。

    Cloud Shell に移動

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

    curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type:
application/json" \
https://maintenance.googleapis.com/v1beta/projects/PROJECT_ID/locations/LOCATION/resourceMaintenances

    次のように置き換えます。

    • PROJECT_ID: プロジェクトのプロジェクト ID。
    • LOCATION: プロジェクトを含むリージョンまたはゾーン。global、region、または -（すべてのロケーションに一致）に設定します。

  3. Unified Maintenance は、指定したプロジェクトのリソースのメンテナンスに関する情報を返します。

リソースのメンテナンスを表示する

Unified Maintenance API を使用すると、指定したリソースのメンテナンスを返すことができます。

指定したリソースのメンテナンスをフィルタして出力するには:

  1. Cloud Shell に移動します。

    Cloud Shell に移動

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

    curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type:
application/json" \
https://maintenance.googleapis.com/v1beta/projects/PROJECT_ID/locations/LOCATION/resourceMaintenances?filter=FILTER=%22RESOURCE_NAME%22

    次のように置き換えます。

    • PROJECT_ID: プロジェクトのプロジェクト ID。
    • LOCATION: プロジェクトを含むリージョンまたはゾーン。global、region、または -（すべてのロケーションに一致）に設定します。
    • RESOURCE_NAME: リソースの完全な名前。

次のステップ