Поделиться через

Task - List Subtasks

  • Ссылка
Служба:
Batch Service
Версия API:
2024-07-01.20.0

Выводит список всех подзадач, связанных с указанной задачей с несколькими экземплярами.
Если задача не является задачей с несколькими экземплярами, возвращается пустая коллекция.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2024-07-01.20.0
С использованием необязательных параметров: 
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя В Обязательно Тип Описание
batchUrl
 path True

string

Базовый URL-адрес для всех запросов пакетной службы Azure.
jobId
 path True

string

Идентификатор задания.
taskId
 path True

string

Идентификатор задачи.
api-version
 query True

string

Версия КЛИЕНТСКОго API.
$select
 query

string

Предложение OData $select.
timeout
 query

integer (int32)

Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

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

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

Имя Обязательно Тип Описание
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 напрямую.

Ответы

Имя Тип Описание
200 OK

CloudTaskListSubtasksResult

Ответ, содержащий список подзадач.

Заголовки

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

BatchError

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

Безопасность

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Олицетворения учетной записи пользователя

Authorization

Тип: apiKey
В: header

Примеры

Task list subtasks

Образец запроса

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2024-07-01.20.0

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "id": 1,
      "startTime": "2016-09-06T06:59:16.3139271Z",
      "endTime": "2016-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2016-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2016-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": "2016-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2016-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.
CloudTaskListSubtasksResult

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

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

Категория ошибки.
ErrorMessage

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

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

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

Состояние подзадаки.
TaskContainerExecutionInformation

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

Результат выполнения задачи.
TaskFailureInformation

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

BatchError

Object

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message

ErrorMessage

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Object

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

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ на ошибку.

CloudTaskListSubtasksResult

Object

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

Имя Тип Описание
value

SubtaskInformation[]

Список подзадач.

ComputeNodeInformation

Object

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

Имя Тип Описание
affinityId

string

Идентификатор узла, на котором выполняется задача, которая может быть передана при добавлении задачи для запроса на планирование задачи на этом вычислительном узле.
nodeId

string

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

string

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

string

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

string

Корневой каталог задачи на вычислительном узле.
taskRootDirectoryUrl

string

URL-адрес корневого каталога задачи на вычислительном узле.

ErrorCategory

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

Категория ошибки.

Значение Описание
servererror

Ошибка возникает из-за проблемы с внутренним сервером.
usererror

Ошибка возникает из-за ошибки пользователя, например неправильной настройки.

ErrorMessage

Object

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

Имя Тип Описание
lang

string

Языковой код сообщения об ошибке
value

string

Текст сообщения.

NameValuePair

Object

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

Имя Тип Описание
name

string

Имя в паре "имя-значение".
value

string

Значение в паре "имя-значение".

SubtaskInformation

Object

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

Имя Тип Описание
containerInfo

TaskContainerExecutionInformation

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

string (date-time)

Время завершения подзадаки.
Это свойство задается только в том случае, если подзадака находится в состоянии Completed.
exitCode

integer (int32)

Код выхода программы, указанной в командной строке подзадаки.
Это свойство задается только в том случае, если подзадака находится в состоянии завершения. Как правило, код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что вы знаете соглашение о коде выхода, используемое процессом приложения. Однако если пакетная служба завершает подзадаку (из-за времени ожидания или завершения пользователя через API), может отображаться определенный операционной системой код выхода.
failureInfo

TaskFailureInformation

Сведения, описывающие сбой задачи, если таковые есть.
Это свойство задается только в том случае, если задача находится в состоянии завершения и возникла ошибка.
id

integer (int32)

Идентификатор подзадаки.
nodeInfo

ComputeNodeInformation

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

SubtaskState

Предыдущее состояние подзадаки.
Это свойство не задано, если подзадача находится в начальном состоянии выполнения.
previousStateTransitionTime

string (date-time)

Время ввода подзадаки в предыдущее состояние.
Это свойство не задано, если подзадача находится в начальном состоянии выполнения.
result

TaskExecutionResult

Результат выполнения задачи.
Если значение равно "сбой", сведения о сбое можно найти в свойстве failureInfo.
startTime

string (date-time)

Время запуска подзадаки. Если подзадака была перезапущена или извлечена, это самое последнее время запуска подзадаки.
state

SubtaskState

Текущее состояние подзадаки.
stateTransitionTime

string (date-time)

Время ввода подзадаки в текущее состояние.

SubtaskState

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

Состояние подзадаки.

Значение Описание
completed

Задача больше не может выполняться, как правило, так как задача успешно завершена, или задача завершилась неудачно и исчерпала его ограничение повтора. Задача также помечается как завершенная, если произошла ошибка при запуске задачи или при завершении задачи.
preparing

Задача была назначена вычислительному узлу, но ожидает завершения необходимой задачи подготовки заданий на вычислительном узле. Если задача подготовки заданий выполнена успешно, задача перейдет к выполнению. Если задача подготовки заданий завершается ошибкой, задача вернется к активному и будет иметь право назначить другому вычислительному узлу.
running

Задача выполняется на вычислительном узле. Это включает подготовку на уровне задачи, например скачивание файлов ресурсов или развертывание пакетов, указанных в задаче, не обязательно означает, что командная строка задачи запущена.

TaskContainerExecutionInformation

Object

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

Имя Тип Описание
containerId

string

Идентификатор контейнера.
error

string

Подробные сведения об ошибке контейнера.
Это подробная строка ошибки из службы Docker, если она доступна. Это эквивалентно полю ошибки, возвращаемой методом "проверка docker".
state

string

Состояние контейнера.
Это состояние контейнера в соответствии со службой Docker. Это эквивалентно полю состояния, возвращаемого методом docker inspect.

TaskExecutionResult

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

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

Значение Описание
failure

Во время обработки задачи произошла ошибка. Возможно, произошел сбой до запуска процесса задачи, в то время как процесс задачи выполнялся или после завершения процесса задачи.
success

Задача успешно запущена.

TaskFailureInformation

Object

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

Имя Тип Описание
category

ErrorCategory

Категория ошибки задачи.
code

string

Идентификатор ошибки задачи. Коды являются инвариантными и предназначены для программного использования.
details

NameValuePair[]

Список дополнительных сведений, связанных с ошибкой.
message

string

Сообщение, описывающее ошибку задачи, предназначенное для отображения в пользовательском интерфейсе.