Job - List Preparation And Release Task Status

Service:

Batch Service

API Version:

2023-11-01.18.0

針對作業執行所在的計算節點，列出指定之作業的作業準備和作業發行工作的執行狀態。
此 API 會傳回所有已執行作業準備或作業發行工作的計算節點上的工作準備和作業發行工作狀態。 這包括已從集區中移除的計算節點。 如果在沒有作業準備或作業發行工作的作業上叫用此 API，Batch 服務會傳回 HTTP 狀態代碼 409 (衝突) ，錯誤碼為 JobPreparationTaskNotSpecified。

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 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
jobId	path	True	string	作業的標識碼。
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	回應中要傳回的項目數目上限。 最多可以傳回 1000 個工作。
timeout	query		integer int32	伺服器可以花費在處理要求的最大時間，以秒為單位。 預設值為 30 秒。

要求標頭

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

名稱	必要	類型	Description
client-request-id		string uuid	呼叫端產生的要求識別，格式為不含大括弧的 GUID，例如大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id		boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date		string date-time-rfc1123	發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱	類型	Description
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

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

Type: apiKey
In: header

範例

Job list preparation and release task status

Sample Request

HTTP

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"
}

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
CloudJobListPreparationAndReleaseTaskStatusResult	列出作業的作業準備和作業發行工作狀態的結果。
ErrorCategory	錯誤類別。
ErrorMessage	在 Azure Batch 錯誤回應中收到的錯誤訊息。
JobPreparationAndReleaseTaskExecutionInformation	計算節點上作業準備和作業發行工作的狀態。
JobPreparationTaskExecutionInformation	包含計算節點上作業準備工作執行的相關信息。
JobPreparationTaskState	計算節點上作業準備工作的目前狀態。
JobReleaseTaskExecutionInformation	包含計算節點上作業發行工作執行的相關信息。
JobReleaseTaskState	計算節點上作業發行工作的目前狀態。
NameValuePair	表示名稱/值組。
TaskContainerExecutionInformation	包含工作執行所在容器的相關信息。
TaskExecutionResult	工作執行的結果。
TaskFailureInformation	工作失敗的相關信息。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應中包含的其他資訊。

CloudJobListPreparationAndReleaseTaskStatusResult

列出作業的作業準備和作業發行工作狀態的結果。

名稱	類型	Description
odata.nextLink	string	要取得下一組結果的URL。
value	JobPreparationAndReleaseTaskExecutionInformation[]	作業準備和作業發行工作執行信息的清單。

ErrorCategory

錯誤類別。

名稱	類型	Description
servererror	string	錯誤是因為內部伺服器問題所造成。
usererror	string	錯誤是因為用戶問題所造成，例如設定錯誤。

ErrorMessage

在 Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。

JobPreparationAndReleaseTaskExecutionInformation

計算節點上作業準備和作業發行工作的狀態。

名稱	類型	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	此計算節點上作業準備工作執行狀態的相關信息。
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	此計算節點上作業發行工作執行狀態的相關信息。 只有在作業發行工作已在計算節點上執行時，才會設定這個屬性。
nodeId	string	此專案所參考之計算節點的識別碼。
nodeUrl	string	此專案所參考之計算節點的 URL。
poolId	string	集區的標識碼，其中包含此專案所參考的計算節點。

JobPreparationTaskExecutionInformation

包含計算節點上作業準備工作執行的相關信息。

名稱	類型	Description
containerInfo	TaskContainerExecutionInformation	工作執行所在容器的相關信息。 只有在 Task 在容器內容中執行時，才會設定這個屬性。
endTime	string	作業準備工作完成的時間。 只有在 Task 處於 [已完成] 狀態時，才會設定這個屬性。
exitCode	integer	Task 命令行上指定之程序的結束代碼。 只有在 Task 處於已完成狀態時，才會傳回此參數。 程序的結束代碼會反映應用程式開發人員針對該程序實作的特定慣例。 如果您使用結束代碼值在程式碼中做出決策，請確定您知道應用程式程式所使用的結束代碼慣例。 請注意，結束代碼也可能由計算節點操作系統產生，例如當進程強制終止時。
failureInfo	TaskFailureInformation	描述工作失敗的資訊，如果有的話。 只有在 Task 處於已完成狀態且遇到失敗時，才會設定這個屬性。
lastRetryTime	string	最近一次重試作業準備工作開始執行。 只有在重試 Task (，也就是 retryCount 為非零) 時，才會設定此屬性。 如果存在，這通常與 startTime 相同，但如果工作因為重試以外的原因而重新啟動，可能會不同;例如，如果在重試期間重新啟動計算節點，則會更新 startTime，但 lastRetryTime 不是。
result	TaskExecutionResult	工作執行的結果。 如果值為 『failed』，則可以在 failureInfo 屬性中找到失敗的詳細數據。
retryCount	integer	Batch 服務重試 Task 的次數。 重試工作應用程式失敗 (非零結束代碼) ， (無法執行工作的前置處理錯誤，) 且不會重試檔案上傳錯誤。 Batch 服務會重試工作，上限為條件約束所指定的限制。 重試工作應用程式失敗 (非零結束代碼) ， (無法執行工作的前置處理錯誤，) 且不會重試檔案上傳錯誤。 Batch 服務會重試工作，上限為條件約束所指定的限制。
startTime	string	工作開始執行的時間。 如果工作已重新啟動或重試，這是工作開始執行的最新時間。
state	JobPreparationTaskState	計算節點上作業準備工作的目前狀態。
taskRootDirectory	string	計算節點上作業準備工作的根目錄。 您可以使用這個路徑來擷取工作所建立的檔案，例如記錄檔。
taskRootDirectoryUrl	string	計算節點上作業準備工作的根目錄 URL。

JobPreparationTaskState

計算節點上作業準備工作的目前狀態。

名稱	類型	Description
completed	string	工作已結束且結束代碼為 0，或工作已耗盡其重試限制，或 Batch 服務因為工作準備錯誤而無法啟動工作， (例如資源文件下載失敗) 。
running	string	工作目前正在執行 (，包括重試) 。

JobReleaseTaskExecutionInformation

包含計算節點上作業發行工作執行的相關信息。

名稱	類型	Description
containerInfo	TaskContainerExecutionInformation	工作執行所在容器的相關信息。 只有在 Task 在容器內容中執行時，才會設定這個屬性。
endTime	string	作業發行工作完成的時間。 只有在 Task 處於 [已完成] 狀態時，才會設定這個屬性。
exitCode	integer	Task 命令行上指定之程序的結束代碼。 只有在 Task 處於已完成狀態時，才會傳回此參數。 程序的結束代碼會反映應用程式開發人員針對該程序實作的特定慣例。 如果您使用結束代碼值在程式碼中做出決策，請確定您知道應用程式程式所使用的結束代碼慣例。 請注意，結束代碼也可能由計算節點操作系統產生，例如當進程強制終止時。
failureInfo	TaskFailureInformation	描述工作失敗的資訊，如果有的話。 只有在 Task 處於已完成狀態且遇到失敗時，才會設定這個屬性。
result	TaskExecutionResult	工作執行的結果。 如果值為 『failed』，則可以在 failureInfo 屬性中找到失敗的詳細數據。
startTime	string	工作開始執行的時間。 如果工作已重新啟動或重試，這是工作開始執行的最新時間。
state	JobReleaseTaskState	計算節點上作業發行工作的目前狀態。
taskRootDirectory	string	計算節點上作業發行工作的根目錄。 您可以使用這個路徑來擷取工作所建立的檔案，例如記錄檔。
taskRootDirectoryUrl	string	計算節點上作業發行工作的根目錄 URL。

JobReleaseTaskState

計算節點上作業發行工作的目前狀態。

名稱	類型	Description
completed	string	工作已結束且結束代碼為 0，或工作已耗盡其重試限制，或 Batch 服務因為工作準備錯誤而無法啟動工作， (例如資源文件下載失敗) 。
running	string	工作目前正在執行 (，包括重試) 。

NameValuePair

表示名稱/值組。

名稱	類型	Description
name	string	name-value 配對中的名稱。
value	string	名稱/值組中的值。

TaskContainerExecutionInformation

包含工作執行所在容器的相關信息。

名稱	類型	Description
containerId	string	容器的標識碼。
error	string	容器的詳細錯誤資訊。 如果有的話，這是 Docker 服務的詳細錯誤字串。 它相當於 「docker inspect」 所傳回的錯誤欄位。
state	string	容器的狀態。 這是根據 Docker 服務之容器的狀態。 它相當於 「docker inspect」 所傳回的狀態欄位。

TaskExecutionResult

工作執行的結果。

名稱	類型	Description
failure	string	處理工作期間發生錯誤。 在啟動工作進程、工作進程執行期間或工作進程結束之後，可能會發生失敗。
success	string	工作已成功執行。

TaskFailureInformation

工作失敗的相關信息。

名稱	類型	Description
category	ErrorCategory	工作錯誤的類別。
code	string	工作錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details	NameValuePair[]	與錯誤相關的其他詳細數據清單。
message	string	描述工作錯誤的訊息，適用於在使用者介面中顯示。