このドキュメントでは、Batch ジョブとタスクを表示する方法について説明します。
準備
- Batch を以前に使用したことがなかった場合は、Batch を使ってみるを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。
-
ジョブとタスクを表示するために必要な権限を取得するには、管理者にプロジェクトのバッチジョブ閲覧者(
roles/batch.jobsViewer
)またはバッチジョブ編集者(roles/batch.jobsEditor
)の IAM ロールを付与するように依頼してください。ロールの付与の詳細については、アクセスの管理をご覧ください。
ジョブを表示する
ジョブを表示するには、次のいずれかの方法を選択します。
プロジェクト内のすべてのジョブを表示するには、ジョブのリストを表示します。
特定のジョブの構成の詳細を確認するには、ジョブの詳細を表示します。
ジョブのリストを表示する
現在のプロジェクトのジョブのリストを表示するには、Google Cloud コンソール、gcloud CLI、Batch API、Go、Java、Node.js、Python、C++ を使用します。
コンソール
Google Cloud コンソールを使用して現在のプロジェクト内のジョブの一覧を表示するには、[ジョブリスト] ページに移動します。
ジョブのリストは複数のページになる場合があります。次のページに進む必要がある場合は、画面下部の
[次へ] をクリックします。省略可: ジョブのリストをフィルタリングする場合は、[
フィルタ] をクリックします。次に、プロパティと値を入力または選択します。たとえば、特定の状態のジョブのみが含まれるようにリストをフィルタリングするには、次のように入力します。
Status:JOB_STATE
JOB_STATE
は、ジョブの状態(FAILED
など)に置き換えます。
gcloud
すべてのジョブを表示
gcloud CLI を使用して現在のプロジェクトのジョブのリストを表示するには、gcloud batch jobs list
コマンドを使用します。
gcloud batch jobs list
フィルタリングされたジョブのリストを表示する
必要に応じて、1 つ以上のフラグを追加して、フィルタリングされたジョブのリストを表示できます。
特定のロケーションのジョブのみを表示するには、
--location
フラグを指定します。フィルタ式に基づいてジョブのみを表示するには、
--filter
フラグを指定します。
たとえば、次のコマンドを使用します。
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
以下を置き換えます。
LOCATION
: 1 つ以上のジョブが存在するロケーション。FILTER_EXPRESSION
: 一覧表示するジョブを定義するフィルタ式。フィルタ式では、ゼロ個以上のブール演算子(AND
、OR
、NOT
)で区切られた 1 つ以上のプロパティと値のペアを定義する必要があります。たとえば、次のフィルタ式をご覧ください。
ジョブの状態に基づいてフィルタ: 特定の状態のジョブのみを表示するには、次のフィルタ式を使用します。
status.state="JOB_STATE"
JOB_STATE
は、ジョブの状態(FAILED
など)に置き換えます。ラベルに基づいてフィルタ: プロジェクトで次のカスタムラベルが定義されているとします。
Cloud Billing レポートを表示するときに調査チームによって作成されたジョブとそのリソースを示すために、一部のジョブとそのリソースには
research
に設定されたteam
ラベルがあります。時間的制約のあるワークロードを示すために、一部のジョブにはさまざまな値に設定された
deadline
ラベルがあります。開発チームが正常にテストした実行可能オブジェクトを示すために、一部の実行可能オブジェクトの
tested
ラベルはtrue
に設定されています。
この場合、次のフィルタ式を指定できます。
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
このフィルタ式では、次の条件をすべて満たすジョブのみが一覧表示されます。
研究チームからのジョブで、ジョブの割り当てポリシーの
team
ラベルがresearch
に設定されているもの。次の条件の 1 つ以上を満たすジョブ。
時間的制約を受け、任意の値に設定された
deadline
ラベルを持つジョブ。正常にテストされた実行可能オブジェクトが 1 つ以上あるジョブ。
true
に設定されたtested
ラベルを持つ実行可能オブジェクトが 1 つ以上あるジョブです。
API
すべてのジョブを表示
Batch API を使用して特定のロケーションにおける現在のプロジェクトのジョブのリストを表示するには、jobs.list
メソッドに GET
リクエストを行います。
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs
以下を置き換えます。
フィルタリングされたジョブのリストを表示する
必要に応じて、filter
クエリ パラメータを指定すると、フィルタ式に基づいてフィルタリングされたジョブのリストを表示できます。
たとえば、次の GET
リクエストを行います。
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION
FILTER_EXPRESSION
を、URL エンコードを使用するフィルタ式に置き換えます。フィルタ式では、ゼロ個以上のブール演算子(AND
、OR
、NOT
)で区切られた 1 つ以上のプロパティと値のペアを定義する必要があります。
たとえば、次のフィルタ式をご覧ください。
ジョブの状態に基づいてフィルタ: 特定の状態のジョブのみを表示するには、次のフィルタ式を使用します。
status.state="JOB_STATE"
JOB_STATE
は、ジョブの状態(FAILED
など)に置き換えます。ラベルに基づいてフィルタ: プロジェクトで次のカスタムラベルが定義されているとします。
Cloud Billing レポートを表示するときに調査チームによって作成されたジョブとそのリソースを示すために、一部のジョブとそのリソースには
research
に設定されたteam
ラベルがあります。時間的制約のあるワークロードを示すために、一部のジョブにはさまざまな値に設定された
deadline
ラベルがあります。開発チームが正常にテストした実行可能オブジェクトを示すために、一部の実行可能オブジェクトの
tested
ラベルはtrue
に設定されています。
この場合、次のフィルタ式を指定できます。
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
このフィルタ式では、次の条件をすべて満たすジョブのみが一覧表示されます。
研究チームからのジョブで、ジョブの割り当てポリシーの
team
ラベルがresearch
に設定されているもの。次の条件の 1 つ以上を満たすジョブ。
時間的制約を受け、任意の値に設定された
deadline
ラベルを持つジョブ。正常にテストされた実行可能オブジェクトが 1 つ以上あるジョブ。
true
に設定されたtested
ラベルを持つ実行可能オブジェクトが 1 つ以上あるジョブです。
Go
Go
詳細については、Batch Go API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
詳細については、Batch Java API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
詳細については、Batch Node.js API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
詳細については、Batch Python API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C++
C++
詳細については、Batch C++ API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
ジョブの詳細を表示する
現在のプロジェクトのジョブの詳細は、Google Cloud コンソール、gcloud CLI、Batch API、Go、Java、Node.js、Python、C++ を使用して表示できます。
コンソール
Google Cloud コンソールを使用して現在のプロジェクトのジョブの詳細を表示するには、次の手順に沿って操作します。
Google Cloud コンソールで、[ジョブリスト] ページに移動します。
[ジョブ名] 列で、ジョブの名前をクリックします。
ジョブの詳細ページが開きます。
デフォルトで [詳細] タブが開きます。詳細については、他のタブをクリックしてください。
gcloud
gcloud CLI を使用して現在のプロジェクトのジョブの詳細を表示するには、--location
フラグを指定して gcloud batch jobs describe
コマンドを使用します。
gcloud batch jobs describe JOB_NAME \
--location=LOCATION
以下を置き換えます。
JOB_NAME
: 既存のジョブの名前。LOCATION
: ジョブが存在するロケーション。
API
Batch API を使用して現在のプロジェクトのジョブの詳細を表示するには、jobs.get
メソッドに GET
リクエストを発行します。
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME
以下を置き換えます。
Go
Go
詳細については、Batch Go API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
詳細については、Batch Java API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
詳細については、Batch Node.js API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
詳細については、Batch Python API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C++
C++
詳細については、Batch C++ API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
タスクを表示する
いずれかのジョブのタスクを表示するには、次のいずれかの方法を選択します。
ジョブまたはジョブのタスクグループ内のすべてのタスクを表示するには、ジョブのタスクのリストを表示します。
特定のタスクのすべての構成の詳細を表示するには、タスクの詳細を表示します。
ジョブのタスクのリストを表示する
Google Cloud コンソール、gcloud CLI、Batch API、Go、Java、Node.js、Python、C++ を使用して、ジョブまたはジョブのタスクグループのタスクのリストを表示できます。
ジョブまたはジョブのタスクグループにあるタスクのリストをフィルタする場合(たとえば、正常に完了したタスクのみを一覧表示する場合)、gcloud CLI または Batch API を使用する必要があります。
コンソール
Google Cloud コンソールを使用してジョブのタスクの概要を表示するには、ジョブの詳細を表示して、[ジョブの詳細] ページを開きます。次に、[タスクの詳細] セクションをご覧ください。
gcloud
gcloud CLI を使用してジョブのタスクグループのタスクのリストを表示するには、次のフラグを指定して gcloud batch tasks list
コマンドを使用します。
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
以下を置き換えます。
JOB_NAME
: 既存のジョブの名前。LOCATION
: ジョブが存在するロケーション。
必要に応じて、--filter
フラグを追加すると、フィルタ式に基づいてジョブのタスクグループ内のタスクをフィルタリングしたリストを表示できます。
たとえば、次のコマンドを使用します。
gcloud batch tasks list \
--job=example-job \
--location=us-central1 \
--filter="FILTER_EXPRESSION"
FILTER_EXPRESSION
は、フィルタ式に置き換えます。
たとえば、次のフィルタ式を指定して、実行中または実行が正常に完了したジョブのタスクグループ内のタスクのみを表示できます。
STATE=RUNNING OR STATE=SUCCEEDED
API
Batch API を使用してジョブのタスクグループ内のタスクのリストを表示するには、tasks.list
メソッドに GET
リクエストを行います。
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks
以下を置き換えます。
PROJECT_ID
: 現在のプロジェクトのプロジェクト ID。LOCATION
: ジョブが存在するロケーション。JOB_NAME
: 既存のジョブの名前。TASK_GROUP_NAME
: 詳細を表示するタスクグループの名前。値はgroup0
に設定する必要があります。
必要に応じて filter
クエリ パラメータを指定すると、フィルタ式に基づいてジョブのタスクグループ内のフィルタリングされたタスクのリストを表示できます。
たとえば、次の GET
リクエストを行います。
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION
FILTER_EXPRESSION
は、URL エンコードを使用するフィルタ式に置き換えます。
たとえば、次のフィルタ式を指定して、実行中または実行が正常に完了したジョブのタスクグループ内のタスクのみを表示できます。
STATE=RUNNING%20OR%20STATE=SUCCEEDED
URL エンコードされたフィルタ式は、次のデコードされたフィルタ式を表すことに留意してください。
STATE=RUNNING OR STATE=SUCCEEDED
Go
Go
詳細については、Batch Go API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
詳細については、Batch Java API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
詳細については、Batch Node.js API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
詳細については、Batch Python API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C++
C++
詳細については、Batch C++ API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
タスクの詳細を表示する
タスクの詳細を表示するには、Google Cloud コンソール、gcloud CLI、Batch API、Go、Java、Node.js、Python、C++ を使用します。
コンソール
Google Cloud コンソールを使用してタスクの詳細を表示するには、ジョブの詳細を表示して、[ジョブの詳細] ページを開きます。次に、[タスクの詳細] セクションをご覧ください。
gcloud
gcloud CLI を使用してタスクの詳細を表示するには、次のフラグを指定して gcloud batch tasks describe
コマンドを使用します。
gcloud batch tasks describe TASK_INDEX \
--location=LOCATION \
--job=JOB_NAME \
--task_group=TASK_GROUP_NAME
以下を置き換えます。
API
Batch API を使用してタスクの詳細を表示するには、tasks.get
メソッドに GET
リクエストを送信します。
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX
以下を置き換えます。
Go
Go
詳細については、Batch Go API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
詳細については、Batch Java API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
詳細については、Batch Node.js API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
詳細については、Batch Python API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C++
C++
詳細については、Batch C++ API のリファレンス ドキュメントをご覧ください。
Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
次のステップ
ジョブのモニタリングと分析の方法を学習します。
ジョブのログを構成した場合、ログを使用してジョブを分析できます。
ステータス通知を構成した場合は、Pub/Sub 通知を使用してジョブをモニタリングし、BigQuery を使用して通知を分析できます。
ラベルを使用してリソースを整理する方法を学習する。
ジョブの削除とエクスポートの方法を確認する。