ステータス イベントを使用してジョブの履歴を表示する

このドキュメントでは、バッチジョブとタスクのステータス イベントを表示する方法について説明します。ステータス イベントは、ジョブの分析に使用できる履歴を提供します。多くの場合、トラブルシューティングに役立つエラー メッセージが含まれています。

各ジョブとその各タスクには、ジョブの実行中に Batch によって自動的に作成されるステータス イベントがあります。各ステータス イベントは、状態の変更と、その状態に到達した理由の詳細を表します。ジョブとタスクの状態については、ジョブのライフサイクルをご覧ください。必要に応じて、実行可能ファイルの進行状況を示すカスタム ステータス イベントを持つようにジョブを構成することもできます。カスタム ステータス イベントの詳細については、カスタム ステータス イベントを構成するをご覧ください。

準備

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

  • ジョブとタスクを表示するために必要な権限を取得するには、管理者にプロジェクトのバッチジョブ閲覧者（roles/batch.jobsViewer）またはバッチジョブ編集者（roles/batch.jobsEditor）の IAM ロールを付与するように依頼してください。ロールの付与の詳細については、アクセスの管理をご覧ください。

    必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ステータス イベントを表示する

次の手順では、Google Cloud コンソール、gcloud CLI、Batch API を使用してステータス イベントを表示する方法について説明します。クライアント ライブラリ言語を使用するには、ジョブの詳細を表示またはタスクの詳細を表示するの手順に沿って操作し、対応する statusEvents[] フィールドをご覧ください。

ジョブのステータス イベントを表示する

コンソール

Google Cloud コンソールを使用して現在のプロジェクトのジョブの詳細を表示するには、次の手順に沿って操作します。

  1. Google Cloud コンソールで、[ジョブリスト] ページに移動します。

    ジョブリストに移動する

  2. [ジョブ名] 列で、ジョブの名前をクリックします。

    [ジョブの詳細] ページが開きます。

    デフォルトで [詳細] タブが開きます。

  3. [イベント] タブをクリックします。

gcloud

gcloud CLI を使用してジョブのステータス イベントを表示するには、gcloud batch jobs describe コマンドを使用して、statusEvents[] フィールドを表示します。

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

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

  • JOB_NAME: 既存のジョブの名前。

  • LOCATION: ジョブが存在するロケーション。

API

Batch API を使用してジョブのステータス イベントを表示するには、jobs.get メソッドに GET リクエストを行い、statusEvents[] フィールドを確認します。

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME

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

タスクのステータス イベントを表示する

コンソール

gcloud

gcloud CLI を使用してタスクのステータス イベントを表示するには、gcloud batch tasks describe コマンドを使用して、statusEvents[] フィールドを表示します。

gcloud batch tasks describe TASK_INDEX \
  --location=LOCATION \
  --job=JOB_NAME \
  --task_group=TASK_GROUP_NAME

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

  • TASK_INDEX: 詳細を表示するタスクのインデックス。タスクグループでは、タスクのインデックスは最初のタスクの 0 から始まり、タスクを追加するごとに 1 ずつ増加します。たとえば、4 つのタスクを含むタスクグループには、インデックス 0、1、2、3 があります。

  • JOB_NAME: 既存のジョブの名前。

  • LOCATION: ジョブが存在するロケーション。

  • TASK_GROUP_NAME: 詳細を表示するタスクを含むタスクグループの名前。値は group0 に設定する必要があります。

API

Batch API を使用してタスクのステータス イベントを表示するには、tasks.get メソッドに GET リクエストを行い、statusEvents[] フィールドを確認します。

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX

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

  • PROJECT_ID: 現在のプロジェクトのプロジェクト ID。

  • LOCATION: ジョブが存在するロケーション。

  • JOB_NAME: 既存のジョブの名前。

  • TASK_GROUP_NAME: 詳細を表示するタスクを含むタスクグループの名前。値は group0 に設定する必要があります。

  • TASK_INDEX: 詳細を表示するタスクのインデックス。タスクグループでは、タスクのインデックスは最初のタスクの 0 から始まり、タスクを追加するごとに 1 ずつ増加します。たとえば、4 つのタスクを含むタスクグループには、インデックス 0、1、2、3 があります。

次のステップ