次の方法で共有

Task - List Subtasks

  • リファレンス
サービス:
Batch Service
API バージョン:
2023-11-01.18.0

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

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2023-11-01.18.0
省略可能なパラメーターを含む: 
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前 / 必須 型 説明
batchUrl
 path True

string

すべてのAzure Batchサービス要求のベース URL。
jobId
 path True

string

ジョブの ID。
taskId
 path True

string

タスクの ID。
api-version
 query True

string

クライアント API のバージョン。
$select
 query

string

OData $select 句。
timeout
 query

integer

int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

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

string

uuid

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

boolean

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

string

date-time-rfc1123

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

応答

名前 型 説明
200 OK

CloudTaskListSubtasksResult

サブタスクの一覧を含む応答。

ヘッダー

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

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Authorization

型: apiKey
/: header

例

Task list subtasks

要求のサンプル

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2023-11-01.18.0

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": 1,
      "startTime": "2016-09-06T06:59:16.3139271Z",
      "endTime": "2016-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2016-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2016-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": "2016-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2016-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エラー応答に含まれる追加情報の項目。
CloudTaskListSubtasksResult

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

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

エラーのカテゴリ。
ErrorMessage

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

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

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

サブタスクの状態。
TaskContainerExecutionInformation

Task が実行しているコンテナーに関する情報が含まれます。
TaskExecutionResult

タスクの実行結果。
TaskFailureInformation

タスクエラーに関する情報。

BatchError

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

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

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

名前 型 説明
key

string

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

string

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

CloudTaskListSubtasksResult

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

名前 型 説明
value

SubtaskInformation[]

サブタスクの一覧。

ComputeNodeInformation

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

名前 型 説明
affinityId

string

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

string

タスクが実行されたコンピューティング ノードの ID。
nodeUrl

string

タスクが実行されたコンピューティング ノードの URL。
poolId

string

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

string

コンピューティング ノード上のタスクのルート ディレクトリ。
taskRootDirectoryUrl

string

コンピューティング ノード上のタスクのルート ディレクトリへの URL。

ErrorCategory

エラーのカテゴリ。

名前 型 説明
servererror

string

このエラーは、内部サーバーの問題が原因です。
usererror

string

このエラーは、構成の誤りなど、ユーザーの問題が原因です。

ErrorMessage

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

名前 型 説明
lang

string

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

string

メッセージのテキストです。

NameValuePair

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

名前 型 説明
name

string

名前と値のペアの名前。
value

string

名前と値のペアの値。

SubtaskInformation

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

名前 型 説明
containerInfo

TaskContainerExecutionInformation

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

string

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

integer

サブタスク・コマンド・ラインで指定されたプログラムの終了コード。
このプロパティは、サブタスクが完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコードで決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスがサブタスクを終了した場合 (タイムアウト、または API を介したユーザー終了が原因)、オペレーティング システム定義の終了コードが表示される場合があります。
failureInfo

TaskFailureInformation

タスクの失敗を説明する情報 (存在する場合)。
このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。
id

integer

サブタスクの ID。
nodeInfo

ComputeNodeInformation

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

SubtaskState

サブタスクの以前の状態。
サブタスクが初期状態の場合、このプロパティは設定されません。
previousStateTransitionTime

string

サブタスクが以前の状態になった時刻。
サブタスクが初期状態の場合、このプロパティは設定されません。
result

TaskExecutionResult

タスク実行の結果。
値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。
startTime

string

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

SubtaskState

サブタスクの現在の状態。
stateTransitionTime

string

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

SubtaskState

サブタスクの状態。

名前 型 説明
completed

string

通常、タスクが正常に完了したか、タスクが正常に完了せず、再試行の制限を使い果たしたため、タスクは実行できません。 タスクは、タスクの起動中にエラーが発生した場合、またはタスクが終了した場合にも完了としてマークされます。
preparing

string

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

string

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

TaskContainerExecutionInformation

Task が実行しているコンテナーに関する情報が含まれます。

名前 型 説明
containerId

string

コンテナーの ID。
error

string

コンテナーに関する詳細なエラー情報。
これは、Docker サービスからの詳細なエラー文字列です (使用可能な場合)。 これは、"docker inspect" によって返されるエラー フィールドと同じです。
state

string

コンテナーの状態。
これは、Docker サービスに従ったコンテナーの状態です。 これは、"docker inspect" によって返される状態フィールドと同じです。

TaskExecutionResult

タスクの実行結果。

名前 型 説明
failure

string

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

string

タスクは正常に実行されました。

TaskFailureInformation

タスクエラーに関する情報。

名前 型 説明
category

ErrorCategory

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

string

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

NameValuePair[]

エラーに関連する追加の詳細の一覧。
message

string

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