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

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, 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, вместо этого используется стандартное значение.".

Заголовок запроса

Имя	Тип	Описание
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 напрямую.

Ответы

Имя	Тип	Описание
200 OK	BatchTaskListSubtasksResult	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

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

Области

Имя	Описание
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"
      }
    }
  ]
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchErrorSourceCategory	Enums BatchErrorSourceCategory
BatchNodeInfo	Сведения о вычислительном узле, на котором выполнялась задача.
BatchSubtask	Сведения о подзадаче пакетной службы Azure.
BatchSubtaskState	Enums BatchSubtaskState
BatchTaskContainerExecutionInfo	Содержит сведения о контейнере, который выполняет задача.
BatchTaskExecutionResult	BatchTaskExecutionResult enums
BatchTaskFailureInfo	Сведения о сбое задачи.
BatchTaskListSubtasksResult	Результат перечисления подзадач задачи.
NameValuePair	Представляет пару "имя-значение".

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchErrorSourceCategory

Перечисление

Enums BatchErrorSourceCategory

Значение	Описание
usererror	Ошибка возникла из-за пользовательской проблемы, например, неправильной настройки.
servererror	Ошибка связана с внутренней проблемой сервера.

BatchNodeInfo

Объект

Сведения о вычислительном узле, на котором выполнялась задача.

Имя	Тип	Описание
affinityId	string	Идентификатор узла, на котором выполнялась задача, который может быть передан при добавлении задачи для запроса на планирование задачи на этом вычислительном узле.
nodeId	string	ID вычислительного узла, на котором выполнялась задача.
nodeUrl	string (uri)	URL вычислительного узла, на котором выполнялась задача.
poolId	string	ID Пула, на котором проходила задача.
taskRootDirectory	string	Корневой каталог задачи на вычислительном узле.
taskRootDirectoryUrl	string (uri)	URL корневого каталога задачи на вычислительном узле.

BatchSubtask

Объект

Сведения о подзадаче пакетной службы Azure.

Имя	Тип	Описание
containerInfo	BatchTaskContainerExecutionInfo	Информация о контейнере, в котором выполняется задача. Это свойство задаётся только если задача выполняется в контейнерном контексте.
endTime	string (date-time)	Время, когда подзадача была завершена. Это свойство задаётся только если подзадача находится в состоянии Complete.
exitCode	integer (int32)	Код выхода программы, указанный в командной строке подзадачи. Это свойство задаётся только если подзадача находится в состоянии завершения. В общем, выходной код процесса отражает конкретную конвенцию, реализованную разработчиком приложения для этого процесса. Если вы используете значение выходного кода для принятия решений в коде, убедитесь, что знаете конвенцию выходного кода, применяемую в процессе применения. Однако если пакетная служба завершает подзадачу (из-за тайм-аута или завершения пользователя через API), вы можете увидеть код выхода, определённый операционной системой.
failureInfo	BatchTaskFailureInfo	Информация, описывающая сбой задачи, если она есть. Это свойство устанавливается только если задача находится в состоянии завершения и столкнулась с ошибкой.
id	integer (int32)	ID подзадачи.
nodeInfo	BatchNodeInfo	Информация о вычислительном узле, на котором выполнялась подзадача.
previousState	BatchSubtaskState	Предыдущее состояние подзадачи. Это свойство не задаётся, если подзадача находится в начальном состоянии выполнения.
previousStateTransitionTime	string (date-time)	Время, когда подзадача вошла в своё прежнее состояние. Это свойство не задаётся, если подзадача находится в начальном состоянии выполнения.
result	BatchTaskExecutionResult	Результат выполнения задачи. Если значение «failed», детали отказа можно найти в свойстве failureInfo.
startTime	string (date-time)	Время, когда подзадача начала выполняться. Если подзадача была перезапущена или попробована заново, это последний момент, когда она начала выполняться.
state	BatchSubtaskState	Текущее состояние подзадачи.
stateTransitionTime	string (date-time)	Время, когда подзадача вошла в своё нынешнее состояние.

BatchSubtaskState

Перечисление

Enums BatchSubtaskState

Значение	Описание
preparing	Задача назначена вычислительному узлу, но ждёт выполнения необходимой задачи подготовки задания на вычислительном узле. Если задание подготовки к работе успешно выполнено, задание переходит к запуску. Если задача подготовки задания не выполняется, задача возвращается в активное состояние и может быть назначена другому вычислительному узлу.
running	Задача выполняется на вычислительном узле. Это включает подготовку на уровне задач, такую как загрузка файлов ресурсов или развертывание пакетов, указанных в задаче — это не обязательно означает, что командная строка задачи уже начала выполняться.
completed	Задание больше не может быть выполнено, обычно потому, что оно успешно завершено или неуспешно завершилось и исчерпал лимит повторных попыток. Задача также отмечается как завершённая, если произошла ошибка при запуске задачи или когда задача была завершена.

BatchTaskContainerExecutionInfo

Объект

Содержит сведения о контейнере, который выполняет задача.

Имя	Тип	Описание
containerId	string	Идентификатор контейнера.
error	string	Подробная информация об ошибках контейнера. Это подробная строка ошибки из сервиса Docker, если она доступна. Он эквивалентен полю ошибки, возвращаемому «docker inspect».
state	string	Состояние контейнера. Это состояние контейнера согласно сервису Docker. Он эквивалентен статусному полю, возвращаемому «docker inspect».

BatchTaskExecutionResult

Перечисление

BatchTaskExecutionResult enums

Значение	Описание
success	Задача прошла успешно.
failure	Произошла ошибка во время обработки задачи. Сбой мог произойти до запуска процесса задачи, во время выполнения процесса задачи или после завершения процесса.

BatchTaskFailureInfo

Объект

Сведения о сбое задачи.

Имя	Тип	Описание
category	BatchErrorSourceCategory	Категория ошибки задачи.
code	string	Идентификатор ошибки задачи. Коды являются инвариантными и предназначены для программного использования.
details	NameValuePair[]	Список дополнительных деталей, связанных с ошибкой.
message	string	Сообщение, описывающее ошибку задачи, предназначенное для отображения в пользовательском интерфейсе.

BatchTaskListSubtasksResult

Объект

Результат перечисления подзадач задачи.

Имя	Тип	Описание
odata.nextLink	string (uri)	URL-адрес для получения следующего набора результатов.
value	BatchSubtask[]	Список подзадач.

NameValuePair

Объект

Представляет пару "имя-значение".

Имя	Тип	Описание
name	string	Имя в паре имя-значение.
value	string	Значение в паре имя-значение.