Batch 用の VM OS イメージを表示する

このページでは、Batch ジョブを実行する仮想マシン（VM）インスタンスで使用可能なオペレーティング システム（OS）イメージを表示する方法について説明します。

特に、このページでは、Batch の VM OS イメージのリストと詳細を表示する方法について説明します。VM OS イメージと Batch で使用できる VM OS イメージの詳細については、VM OS 環境の概要をご覧ください。Compute Engine の公開イメージやカスタム イメージなど、他の VM OS イメージを確認する場合は、Compute Engine イメージのドキュメントをご覧ください。

準備

1. Batch を以前に使用したことがなかった場合は、Batch を使ってみるを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。

Batch の VM OS イメージのリストを表示する

gcloud CLI または Batch API を使用して、Batch のすべての VM OS イメージのリストを表示できます。

gcloud

サポートされているすべての Batch の VM OS イメージを一覧表示するには、次の gcloud compute images list コマンドを使用します。

gcloud compute images list \
    --project=batch-custom-image \
    --no-standard-images

• Batch のイメージを一覧表示するには、--project=batch-custom-image フラグが必要です。
• --no-standard-images フラグを使用すると、Compute Engine の標準イメージが除外されます。
• 省略可: 非推奨の Batch イメージを表示する必要がある場合は、--show-deprecated フラグも指定します。

各 VM OS イメージの出力は次のようになります。

NAME: IMAGE_NAME
PROJECT: IMAGE_PROJECT_ID
FAMILY: IMAGE_FAMILY
...

この出力には次の値が含まれます。

• IMAGE_NAME: イメージの名前。 イメージ名は、VM OS イメージの特定のバージョンを表します。たとえば、イメージ名 batch-debian-11-official-20230802-00-p00 は、イメージ ファミリー batch-debian-11-official のイメージ バージョン -20230802-00-p00（2023 年 8 月 2 日以降のバージョン）を表します。
• IMAGE_PROJECT_ID: イメージを含むプロジェクトのプロジェクト ID。たとえば、Batch イメージのすべてのイメージは batch-custom-image プロジェクトにあります。
• IMAGE_FAMILY: イメージのファミリー。1 つ以上の特定のイメージが含まれるイメージ ファミリーと、OS の種類とメジャー バージョンを表します。たとえば、batch-debian-11-official イメージ ファミリーには、Compute Engine の Debian の OS バージョン 11 に基づく Batch イメージが含まれています。

API

サポートされているすべての Batch の VM OS イメージを一覧表示するには、images.list メソッドに次のリクエストを送信します。

GET https://compute.googleapis.com/compute/v1/projects/batch-custom-image/global/images?filter=(-deprecated%3A*)%20OR%20(deprecated.state%3D%22ACTIVE%22)

• Batch のイメージを一覧表示するには、batch-custom-image プロジェクトが必要です。
• ?filter=(-deprecated%3A*)%20OR%20(deprecated.state%3D%22ACTIVE%22) クエリ パラメータは、URL エンコードを使用して filter フィールドを (-deprecated:*) OR (deprecated.state="ACTIVE") に設定することで、非推奨のイメージを除外します。
  • 省略可: 非推奨の Batch イメージを表示する必要がある場合は、?filter=(-deprecated%3A*)%20OR%20(deprecated.state%20%3D%20%22ACTIVE%22) クエリ パラメータを削除します。

各 VM OS イメージの出力は次のようになります。

{
  ...
  "name": "IMAGE_NAME",
  ...
  "family": "IMAGE_FAMILY",
  "selfLink": "https://www.googleapis.com/compute/v1/projects/IMAGE_PROJECT_ID/global/images/IMAGE_NAME",
  ...
}

この出力には次の値が含まれます。

• IMAGE_NAME: イメージの名前。 イメージ名は、VM OS イメージの特定のバージョンを表します。たとえば、イメージ名 batch-debian-11-official-20230802-00-p00 は、イメージ ファミリー batch-debian-11-official のイメージ バージョン -20230802-00-p00（2023 年 8 月 2 日以降のバージョン）を表します。
• IMAGE_PROJECT_ID: イメージを含むプロジェクトのプロジェクト ID。たとえば、Batch イメージのすべてのイメージは batch-custom-image プロジェクトにあります。
• IMAGE_FAMILY: イメージのファミリー。1 つ以上の特定のイメージが含まれるイメージ ファミリーと、OS の種類とメジャー バージョンを表します。たとえば、batch-debian-11-official イメージ ファミリーには、Compute Engine の Debian の OS バージョン 11 に基づく Batch イメージが含まれています。

Batch の VM OS イメージの詳細を表示する

VM OS イメージの詳細をすべて表示するには、gcloud CLI または Batch API を使用します。

gcloud

Batch の VM OS イメージの詳細を表示するには、gcloud compute images describe コマンドを使用して、イメージ プロジェクトとして batch-custom-image を指定します。

gcloud compute images describe IMAGE_NAME --project=batch-custom-image

IMAGE_NAME は、記述する Batch の VM OS イメージの名前に置き換えます。

API

Batch の VM OS イメージの詳細を表示するには、images.get メソッドにリクエストを送信し、イメージ プロジェクトとして batch-custom-image を指定します。

GET https://compute.googleapis.com/compute/v1/projects/batch-custom-image/global/images/IMAGE_NAME

IMAGE_NAME は、記述する Batch の VM OS イメージの名前に置き換えます。

次のステップ

• Batch 用の VM OS イメージの詳細を確認する。
  • VM OS 環境の概要
  • ジョブ用の VM OS イメージを指定する