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

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點（例如：https://batchaccount.eastus2.batch.azure.com）。
jobId	path	True	string	工作識別。
taskId	path	True	string	任務的ID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
$select	query		string[]	OData $select 子句。
timeOut	query		integer (int32)	伺服器可以花費數秒處理要求的時間上限。預設值為 30 秒。若值大於30，則會使用預設值。」

要求標頭

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

回應

名稱	類型	Description
200 OK	BatchTaskListSubtasksResult	要求已成功。標題 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	未預期的錯誤回應。

名稱

類型

Description

200 OK

BatchTaskListSubtasksResult

要求已成功。

標題

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
https://batch.core.windows.net//.default

範例

Task list subtasks

範例要求

HTTP

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

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
BatchErrorSourceCategory	BatchErrorSourceCategory 的列舉
BatchNodeInfo	工作執行所在的計算節點相關信息。
BatchSubtask	Azure Batch 子工作的相關信息。
BatchSubtaskState	BatchSubtaskState 枚舉
BatchTaskContainerExecutionInfo	包含工作執行所在的容器相關信息。
BatchTaskExecutionResult	BatchTaskExecutionResult 的枚舉
BatchTaskFailureInfo	工作失敗的相關信息。
BatchTaskListSubtasksResult	列出Task子工作的結果。
NameValuePair	表示名稱/值組。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

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

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

BatchErrorSourceCategory

列舉型別

BatchErrorSourceCategory 的列舉

值	Description
usererror	錯誤是因為使用者問題，例如設定錯誤。
servererror	錯誤是因為內部伺服器的問題。

BatchNodeInfo

Object

工作執行所在的計算節點相關信息。

名稱	類型	Description
affinityId	string	任務執行節點的識別碼，可在新增任務時傳遞，請求任務排程至此計算節點。
nodeId	string	任務執行的計算節點的 ID。
nodeUrl	string (uri)	任務執行的計算節點的網址。
poolId	string	任務執行的池子編號。
taskRootDirectory	string	任務在計算節點上的根目錄。
taskRootDirectoryUrl	string (uri)	計算節點上任務根目錄的網址。

BatchSubtask

Object

Azure Batch 子工作的相關信息。

名稱	類型	Description
containerInfo	BatchTaskContainerExecutionInfo	關於任務執行容器的資訊。此屬性僅在任務在容器上下文中執行時被設定。
endTime	string (date-time)	子任務完成的時間。此屬性僅在子任務處於完成狀態時設定。
exitCode	integer (int32)	程式的退出碼在子任務命令列中指定。此屬性僅在子任務處於完成狀態時設定。一般而言，程序的退出碼反映應用程式開發者為該程序實作的特定慣例。如果你用出口代碼值來做決策，務必了解應用程式流程所使用的退出代碼慣例。然而，如果批次服務因逾時或使用者透過 API 終止而終止子任務，你可能會看到作業系統定義的退出代碼。
failureInfo	BatchTaskFailureInfo	描述任務失敗的資訊（如有）。此屬性僅在任務處於完成狀態且遇到失敗時才會設定。
id	integer (int32)	子任務的ID。
nodeInfo	BatchNodeInfo	關於子任務執行的計算節點的資訊。
previousState	BatchSubtaskState	子任務的前一個狀態。若子任務處於初始執行狀態，則此屬性不被設定。
previousStateTransitionTime	string (date-time)	子任務進入先前狀態的時間點。若子任務處於初始執行狀態，則此屬性不被設定。
result	BatchTaskExecutionResult	任務執行的結果。如果值為「失敗」，那麼失敗的詳細資料可以在 failureInfo 屬性中找到。
startTime	string (date-time)	子任務開始執行的時間。若子任務已重新啟動或重試，則為該子任務最近一次開始執行的時間。
state	BatchSubtaskState	子任務目前的狀態。
stateTransitionTime	string (date-time)	子任務進入目前狀態的時間點。

BatchSubtaskState

列舉型別

BatchSubtaskState 枚舉

值	Description
preparing	該任務已被指派到計算節點，但正在等待計算節點上完成所需的工作準備任務。如果工作準備任務成功，任務將進入執行階段。若工作準備任務失敗，該任務將恢復為啟用狀態，並有資格分配至其他計算節點。
running	任務是在計算節點上執行。這包括任務層級的準備，例如下載資源檔案或部署任務指定的套件——這不一定代表任務命令列已經開始執行。
completed	任務不再有資格執行，通常是因為任務已成功完成，或任務未完成且已用盡重試限制。若任務啟動時發生錯誤，或任務已被終止，任務也會被標記為已完成。

BatchTaskContainerExecutionInfo

Object

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

名稱	類型	Description
containerId	string	貨櫃的識別碼。
error	string	關於容器的詳細錯誤資訊。這是 Docker 服務中詳細的錯誤字串（如果有的話）。它等同於由「docker inspect」回傳的錯誤欄位。
state	string	貨櫃的狀態。這是根據 Docker 服務所顯示的容器狀態。它等同於「docker inspect」回傳的狀態欄位。

BatchTaskExecutionResult

列舉型別

BatchTaskExecutionResult 的枚舉

值	Description
success	任務順利進行。
failure	任務處理過程中發生錯誤。故障可能發生在任務程序啟動前、執行中，或任務程序退出後。

BatchTaskFailureInfo

Object

工作失敗的相關信息。

名稱	類型	Description
category	BatchErrorSourceCategory	任務錯誤的類別。
code	string	任務錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	NameValuePair[]	與錯誤相關的額外細節清單。
message	string	一則描述任務錯誤的訊息，旨在用於使用者介面顯示。

BatchTaskListSubtasksResult

Object

列出Task子工作的結果。

名稱	類型	Description
odata.nextLink	string (uri)	取得下一組結果的 URL。
value	BatchSubtask[]	子任務清單。

NameValuePair

Object

表示名稱/值組。

名稱	類型	Description
name	string	名稱與值對中的名字。
value	string	名稱與值對中的值。

共用方式為

Tasks - List Sub Tasks

URI 參數

要求標頭

回應

安全性

OAuth2Auth

範圍

範例

Task list subtasks

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchErrorSourceCategory

BatchNodeInfo

BatchSubtask

BatchSubtaskState

BatchTaskContainerExecutionInfo

BatchTaskExecutionResult

BatchTaskFailureInfo

BatchTaskListSubtasksResult

NameValuePair