次の方法で共有

Tasks - List Sub Tasks

サービス:
Batch Service
API バージョン:
2025-06-01

指定されたマルチインスタンスタスクに関連付けられたすべてのサブタスクを一覧にします。
タスクがマルチインスタンスタスクでない場合、空のコレクションを返します。

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01
省略可能なパラメーターを含む: 
GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01&timeOut={timeOut}&$select={$select}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string (uri)

Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
jobId
 path True

string

仕事のIDだ。
taskId
 path True

string

タスクのID。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。
$select
 query

string[]

OData $select 句。
timeOut
 query

integer (int32)

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

名前 必須 型 説明
client-request-id

string

呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id

boolean

サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date

string (date-time-rfc7231)

要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前 型 説明
200 OK

BatchTaskListSubtasksResult

要求は成功しました。

ヘッダー

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前 説明
https://batch.core.windows.net//.default

例

Task list subtasks

要求のサンプル

GET {endpoint}/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2025-06-01

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": 1,
      "startTime": "2025-09-06T06:59:16.3139271Z",
      "endTime": "2025-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2025-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2025-09-06T06:59:16.3139271Z",
      "exitCode": 0,
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_3-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_3-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1"
      }
    },
    {
      "id": 2,
      "startTime": "2025-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2025-09-06T06:59:16.9702844Z",
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_2-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_2-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2"
      }
    }
  ]
}

定義

名前 説明
BatchError

Azure Batch サービスから受信したエラー応答。
BatchErrorDetail

Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage

Azure Batch エラー応答で受信したエラー メッセージ。
BatchErrorSourceCategory

BatchErrorSourceCategory の列挙
BatchNodeInfo

タスクが実行されたコンピューティング ノードに関する情報。
BatchSubtask

Azure Batch サブタスクに関する情報。
BatchSubtaskState

バッチSubtask状態の列挙
BatchTaskContainerExecutionInfo

タスクが実行されているコンテナーに関する情報を格納します。
BatchTaskExecutionResult

BatchTaskExecutionResultの列挙
BatchTaskFailureInfo

タスクの失敗に関する情報。
BatchTaskListSubtasksResult

タスクのサブタスクを一覧表示した結果。
NameValuePair

名前と値のペアを表します。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message

BatchErrorMessage

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values

BatchErrorDetail[]

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前 型 説明
key

string

Value プロパティの意味を指定する識別子。
value

string

エラー応答に含まれる追加情報。

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラー メッセージ。

名前 型 説明
lang

string

エラーメッセージの言語コード。
value

string

メッセージのテキスト。

BatchErrorSourceCategory

列挙

BatchErrorSourceCategory の列挙

値 説明
usererror

このエラーはユーザーの問題、例えば設定ミスが原因です。
servererror

このエラーは内部サーバーの問題によるものです。

BatchNodeInfo

Object

タスクが実行されたコンピューティング ノードに関する情報。

名前 型 説明
affinityId

string

タスクが実行されるノードの識別子で、タスクを追加する際にこのコンピュートノードでのスケジュールを要求する際に渡すことができます。
nodeId

string

タスクが実行されるComputeノードのID。
nodeUrl

string (uri)

タスクが動作するComputeノードのURLです。
poolId

string

タスクが実施されたプールのID。
taskRootDirectory

string

Computeノード上のタスクのルートディレクトリ。
taskRootDirectoryUrl

string (uri)

Computeノード上のタスクのルートディレクトリへのURL。

BatchSubtask

Object

Azure Batch サブタスクに関する情報。

名前 型 説明
containerInfo

BatchTaskContainerExecutionInfo

タスクが実行されているコンテナに関する情報。 このプロパティは、タスクがコンテナコンテキストで実行される場合にのみ設定されます。
endTime

string (date-time)

サブタスクが完了した時刻。 このプロパティは、サブタスクが完了状態にある場合にのみ設定されます。
exitCode

integer (int32)

サブタスクコマンドラインで指定されたプログラムの終了コード。 このプロパティはサブタスクが完了状態にある場合にのみ設定されます。 一般的に、プロセスの終了コードは、そのプロセスに対してアプリケーション開発者が実装した特定の慣習を反映しています。 コード内で判定に出口コードの値を使う場合は、アプリケーションプロセスで使われる出口コードの規則を必ず把握してください。 しかし、バッチサービスがタイムアウトやAPIによるユーザー終了によりサブタスクを終了すると、OSが定義した終了コードが表示されることがあります。
failureInfo

BatchTaskFailureInfo

タスクの失敗に関する情報(あれば)も含まれます。 このプロパティは、タスクが完了状態にあり、失敗が発生した場合のみ設定されます。
id

integer (int32)

サブタスクのID。
nodeInfo

BatchNodeInfo

サブタスクが動作するCompute Nodeに関する情報。
previousState

BatchSubtaskState

サブタスクの前の状態。 この性質は、サブタスクが初期実行状態にある場合は設定されません。
previousStateTransitionTime

string (date-time)

サブタスクが前の状態に入る時刻。 この性質は、サブタスクが初期実行状態にある場合は設定されません。
result

BatchTaskExecutionResult

タスク実行の結果です。 値が「失敗」の場合、失敗の詳細はfailureInfoプロパティで確認できます。
startTime

string (date-time)

サブタスクが実行を開始した時間。 サブタスクが再起動または再試行された場合、これはサブタスクが実行を開始した最新の時刻です。
state

BatchSubtaskState

サブタスクの現状。
stateTransitionTime

string (date-time)

サブタスクが現在の状態に入る時刻。

BatchSubtaskState

列挙

バッチSubtask状態の列挙

値 説明
preparing

タスクはコンピュートノードに割り当てられていますが、コンピュートノード上で必要なジョブ準備タスクの完了を待っています。 ジョブ準備タスクが成功すると、タスクは実行に移行します。 ジョブ準備タスクが失敗した場合、タスクは再びアクティブに戻り、別の計算ノードに割り当てられる資格が得られます。
running

タスクはコンピュートノード上で実行されています。 これには、リソースファイルのダウンロードやタスク上で指定されたパッケージのデプロイなどのタスクレベルの準備も含まれますが、必ずしもタスクコマンドラインの実行が始まったという意味ではありません。
completed

タスクは実行できなくなり、通常はタスクが成功裏に完了したか、失敗して再試行制限を使い果たした場合に限られます。 タスクは、タスクの起動時にエラーが発生した場合や終了した場合も完了済みとマークされます。

BatchTaskContainerExecutionInfo

Object

タスクが実行されているコンテナーに関する情報を格納します。

名前 型 説明
containerId

string

コンテナーの ID。
error

string

コンテナに関する詳細なエラー情報。 これは、もし利用可能な場合、Dockerサービスからの詳細なエラー文字列です。 これは「docker inspect」で返されるエラーフィールドと同等です。
state

string

コンテナの状態。 これはDockerサービスによるコンテナの状態です。 これは「docker inspect」で返されるステータスフィールドと同等です。

BatchTaskExecutionResult

列挙

BatchTaskExecutionResultの列挙

値 説明
success

このタスクは成功裏に実施されました。
failure

タスクの処理中にエラーが発生しました。 失敗はタスクプロセスが起動される前、実行中、またはタスクプロセス終了後に発生した可能性があります。

BatchTaskFailureInfo

Object

タスクの失敗に関する情報。

名前 型 説明
category

BatchErrorSourceCategory

タスクエラーのカテゴリ。
code

string

タスクエラーの識別子です。 コードは不変であり、プログラムで使用することを目的としています。
details

NameValuePair[]

エラーに関連する追加情報の一覧。
message

string

タスクエラーを説明するメッセージで、ユーザーインターフェースでの表示に適したものでした。

BatchTaskListSubtasksResult

Object

タスクのサブタスクを一覧表示した結果。

名前 型 説明
odata.nextLink

string (uri)

次の結果セットを取得するための URL。
value

BatchSubtask[]

サブタスクのリスト。

NameValuePair

Object

名前と値のペアを表します。

名前 型 説明
name

string

名前と値の組み合わせに入っている名前。
value

string

名前と値のペアの価値です。