Job - List Preparation And Release Task Status

  • リファレンス
Service:
Batch Service
API Version:
2023-11-01.18.0

ジョブが実行されているコンピューティング ノード全体で、指定したジョブのジョブ準備タスクとジョブ 解放タスクの実行状態を一覧表示します。
この API は、ジョブ準備タスクまたはジョブ解放タスクを実行したすべてのコンピューティング ノードのジョブ準備タスクとジョブ 解放タスクの状態を返します。 これには、プールから削除されたコンピューティング ノードが含まれます。 ジョブ準備タスクまたはジョブ 解放タスクがないジョブでこの API が呼び出された場合、Batch サービスはエラー コード JobPreparationTaskNotSpecified を使用して HTTP 状態コード 409 (競合) を返します。

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前 / 必須 型 説明
batchUrl
 path True

string

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

string

ジョブの ID。
api-version
 query True

string

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

string

OData $filter 句。 このフィルターの構築の詳細については、「」を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status。
$select
 query

string

OData $select 句。
maxresults
 query

integer

int32

応答で返される項目の最大数。 最大 1,000 個のタスクを返すことができます。
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

CloudJobListPreparationAndReleaseTaskStatusResult

ジョブの準備とジョブ解放タスクの状態の一覧を含む応答。

Headers

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

BatchError

Batch サービスからのエラー。 ジョブ準備タスクまたはジョブ 解放タスクがないジョブでこの API が呼び出された場合、Batch サービスは HTTP 状態コード 409 を返します。

セキュリティ

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

例

Job list preparation and release task status

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

定義

名前 説明
BatchError

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

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

ジョブのジョブ準備タスクとジョブ 解放タスクの状態を一覧表示した結果。
ErrorCategory

エラーのカテゴリ。
ErrorMessage

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

コンピューティング ノード上のジョブ準備タスクとジョブ 解放タスクの状態。
JobPreparationTaskExecutionInformation

コンピューティング ノードでのジョブ準備タスクの実行に関する情報が含まれます。
JobPreparationTaskState

コンピューティング ノード上のジョブ準備タスクの現在の状態。
JobReleaseTaskExecutionInformation

コンピューティング ノードでのジョブ リリース タスクの実行に関する情報が含まれます。
JobReleaseTaskState

コンピューティング ノード上のジョブ リリース タスクの現在の状態。
NameValuePair

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

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

タスクの実行結果。
TaskFailureInformation

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

BatchError

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

名前 型 説明
code

string

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

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

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

名前 型 説明
key

string

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

string

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

CloudJobListPreparationAndReleaseTaskStatusResult

ジョブのジョブ準備タスクとジョブ 解放タスクの状態を一覧表示した結果。

名前 型 説明
odata.nextLink

string

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

JobPreparationAndReleaseTaskExecutionInformation[]

ジョブの準備とジョブの解放タスクの実行情報の一覧。

ErrorCategory

エラーのカテゴリ。

名前 型 説明
servererror

string

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

string

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

ErrorMessage

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

名前 型 説明
lang

string

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

string

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

JobPreparationAndReleaseTaskExecutionInformation

コンピューティング ノード上のジョブ準備タスクとジョブ 解放タスクの状態。

名前 型 説明
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

このコンピューティング ノードのジョブ準備タスクの実行状態に関する情報。
jobReleaseTaskExecutionInfo

JobReleaseTaskExecutionInformation

このコンピューティング ノードのジョブ リリース タスクの実行状態に関する情報。
このプロパティは、ジョブ解放タスクがコンピューティング ノードで実行されている場合にのみ設定されます。
nodeId

string

このエントリが参照するコンピューティング ノードの ID。
nodeUrl

string

このエントリが参照するコンピューティング ノードの URL。
poolId

string

このエントリが参照するコンピューティング ノードを含むプールの ID。

JobPreparationTaskExecutionInformation

コンピューティング ノードでのジョブ準備タスクの実行に関する情報が含まれます。

名前 型 説明
containerInfo

TaskContainerExecutionInformation

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

string

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

integer

タスク コマンド ラインで指定されたプログラムの終了コード。
このパラメーターは、Task が完了状態の場合にのみ返されます。 プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されています。 終了コード値を使用してコードで決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 プロセスが強制的に終了された場合など、コンピューティング ノード オペレーティング システムによって終了コードが生成される場合もあります。
failureInfo

TaskFailureInformation

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

string

ジョブ準備タスクの再試行が実行を開始した最新の時刻。
このプロパティは、Task が再試行された場合 (つまり、retryCount が 0 以外の場合) にのみ設定されます。 存在する場合、これは通常 startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、コンピューティング ノードが再試行中に再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。
result

TaskExecutionResult

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

integer

Batch サービスによってタスクが再試行された回数。 タスク アプリケーションのエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした) とファイルのアップロード エラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。
タスク アプリケーションのエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした) とファイルのアップロード エラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。
startTime

string

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

JobPreparationTaskState

コンピューティング ノード上のジョブ準備タスクの現在の状態。
taskRootDirectory

string

コンピューティング ノード上のジョブ準備タスクのルート ディレクトリ。 このパスを使用して、ログ ファイルなど、タスクによって作成されたファイルを取得できます。
taskRootDirectoryUrl

string

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

JobPreparationTaskState

コンピューティング ノード上のジョブ準備タスクの現在の状態。

名前 型 説明
completed

string

タスクが終了コード 0 で終了したか、タスクが再試行の制限を超えているか、タスク準備エラー (リソース ファイルのダウンロードエラーなど) が原因で Batch サービスがタスクを開始できませんでした。
running

string

タスクは現在実行中です (再試行を含む)。

JobReleaseTaskExecutionInformation

コンピューティング ノードでのジョブ リリース タスクの実行に関する情報が含まれます。

名前 型 説明
containerInfo

TaskContainerExecutionInformation

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

string

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

integer

タスク コマンド ラインで指定されたプログラムの終了コード。
このパラメーターは、Task が完了状態の場合にのみ返されます。 プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されています。 終了コード値を使用してコードで決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 プロセスが強制的に終了された場合など、コンピューティング ノード オペレーティング システムによって終了コードが生成される場合もあります。
failureInfo

TaskFailureInformation

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

TaskExecutionResult

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

string

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

JobReleaseTaskState

コンピューティング ノード上のジョブ リリース タスクの現在の状態。
taskRootDirectory

string

コンピューティング ノード上のジョブ リリース タスクのルート ディレクトリ。 このパスを使用して、ログ ファイルなど、タスクによって作成されたファイルを取得できます。
taskRootDirectoryUrl

string

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

JobReleaseTaskState

コンピューティング ノード上のジョブ リリース タスクの現在の状態。

名前 型 説明
completed

string

タスクが終了コード 0 で終了したか、タスクが再試行の制限を超えているか、タスク準備エラー (リソース ファイルのダウンロードエラーなど) が原因で Batch サービスがタスクを開始できませんでした。
running

string

タスクは現在実行中です (再試行を含む)。

NameValuePair

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

名前 型 説明
name

string

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

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

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