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

Task - List Subtasks

  • Ссылка
Service:
Batch Service
API Version:
2023-11-01.18.0

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

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.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 секунд.

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

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

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

Headers

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

BatchError

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

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

azure_auth

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

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Task list subtasks

Sample Request

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2023-11-01.18.0

Sample Response

Status code:
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

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

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

string

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

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

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

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

string

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

string

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

CloudTaskListSubtasksResult

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

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

SubtaskInformation[]

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

ComputeNodeInformation

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

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

string

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

string

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

string

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

string

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

string

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

string

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

ErrorCategory

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

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

string

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

string

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

ErrorMessage

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

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

string

Код языка сообщения об ошибке
value

string

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

NameValuePair

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

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

string

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

string

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

SubtaskInformation

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

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

TaskContainerExecutionInformation

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

string

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

integer

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

TaskFailureInformation

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

integer

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

ComputeNodeInformation

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

SubtaskState

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

string

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

TaskExecutionResult

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

string

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

SubtaskState

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

string

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

SubtaskState

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

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

string

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

string

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

string

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

TaskContainerExecutionInformation

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

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

string

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

string

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

string

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

TaskExecutionResult

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

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

string

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

string

Задача успешно выполнена.

TaskFailureInformation

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

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

ErrorCategory

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

string

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

NameValuePair[]

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

string

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