Job - List Preparation And Release Task Status

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

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2021-06-01.14.0
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2021-06-01.14.0

URI パラメーター

Name In Required Type Description
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"

Name Required Type Description
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します。

応答

Name Type Description
200 OK

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

Headers

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

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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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

Scopes

Name Description
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=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT

Sample Response

{
  "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=2021-06-01.14.0"
}

定義

BatchError

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

BatchErrorDetail

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

CloudJobListPreparationAndReleaseTaskStatusResult

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

ErrorCategory

エラーのカテゴリ。

ErrorMessage

エラー応答中に受信Azure Batchエラー メッセージ。

JobPreparationAndReleaseTaskExecutionInformation

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

JobPreparationTaskExecutionInformation

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

JobPreparationTaskState

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

JobReleaseTaskExecutionInformation

コンピューティング ノードでのジョブ解放タスクの実行に関する情報を格納します。

JobReleaseTaskState

計算ノードでのジョブ解放タスクの現在の状態です。

NameValuePair

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

TaskContainerExecutionInformation

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

TaskExecutionResult

タスクの実行結果。

TaskFailureInformation

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

BatchError

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

Name Type Description
code
  • string

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

message

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

values

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

BatchErrorDetail

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

Name Type Description
key
  • string

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

value
  • string

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

CloudJobListPreparationAndReleaseTaskStatusResult

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

Name Type Description
odata.nextLink
  • string

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

value

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

ErrorCategory

エラーのカテゴリ。

Name Type Description
servererror
  • string

このエラーは、内部サーバーの問題が原因で発生します。

usererror
  • string

このエラーは、間違った構成などのユーザーの問題が原因で発生します。

ErrorMessage

エラー応答中に受信Azure Batchエラー メッセージ。

Name Type Description
lang
  • string

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

value
  • string

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

JobPreparationAndReleaseTaskExecutionInformation

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

Name Type Description
jobPreparationTaskExecutionInfo

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

jobReleaseTaskExecutionInfo

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

nodeId
  • string

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

nodeUrl
  • string

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

poolId
  • string

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

JobPreparationTaskExecutionInformation

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

Name Type Description
containerInfo

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

endTime
  • string

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

exitCode
  • integer

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

failureInfo

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

lastRetryTime
  • string

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

result

タスク実行の結果。
値が "failed" の場合、エラーの詳細は failureInfo プロパティにあります。

retryCount
  • integer

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

startTime
  • string

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

state

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

taskRootDirectory
  • string

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

taskRootDirectoryUrl
  • string

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

JobPreparationTaskState

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

Name Type Description
completed
  • string

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

running
  • string

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

JobReleaseTaskExecutionInformation

コンピューティング ノードでのジョブ解放タスクの実行に関する情報を格納します。

Name Type Description
containerInfo

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

endTime
  • string

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

exitCode
  • integer

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

failureInfo

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

result

タスク実行の結果。
値が "failed" の場合、エラーの詳細は failureInfo プロパティにあります。

startTime
  • string

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

state

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

taskRootDirectory
  • string

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

taskRootDirectoryUrl
  • string

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

JobReleaseTaskState

計算ノードでのジョブ解放タスクの現在の状態です。

Name Type Description
completed
  • string

タスクが終了コード0で終了したか、タスクが再試行の制限を超えたか、タスクの準備エラー (リソースファイルのダウンロードに失敗しました) が発生したため、Batch サービスがタスクを開始できませんでした。

running
  • string

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

NameValuePair

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

Name Type Description
name
  • string

名前と値のペアの名前。

value
  • string

名前と値のペアの値。

TaskContainerExecutionInformation

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

Name Type Description
containerId
  • string

コンテナーの ID。

error
  • string

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

state
  • string

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

TaskExecutionResult

タスクの実行結果。

Name Type Description
failure
  • string

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

success
  • string

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

TaskFailureInformation

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

Name Type Description
category

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

code
  • string

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

details

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

message
  • string

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