Job - List Preparation And Release Task Status

Ссылка

Служба:: Batch Service

Версия API:: 2024-07-01.20.0

Выводит состояние выполнения задачи подготовки задания и выпуска задания для указанного задания на вычислительных узлах, где выполняется задание.
Этот API возвращает состояние задачи подготовки задания и выпуска задания на всех вычислительных узлах, которые выполняют задачу подготовки задания или выпуска задания. К ним относятся вычислительные узлы, которые с тех пор были удалены из пула. Если этот API вызывается в задании, в котором нет задачи подготовки заданий или выпуска задания, пакетная служба возвращает код состояния HTTP 409 (конфликт) с кодом ошибки JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

С использованием необязательных параметров:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
jobId	path	True	string	Идентификатор задания.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$filter	query		string	Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://learn.microsoft.com/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 секунд. Если значение больше 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	CloudJobListPreparationAndReleaseTaskStatusResult	Ответ, содержащий список состояний задачи подготовки задания и выпуска задания. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы. Если этот API вызывается в задании, в котором нет задачи подготовки заданий или выпуска задания, служба пакетной службы возвращает код состояния HTTP 409.

Имя

Тип

Описание

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Ответ, содержащий список состояний задачи подготовки задания и выпуска задания.

Заголовки

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

Other Status Codes

BatchError

Ошибка из пакетной службы. Если этот API вызывается в задании, в котором нет задачи подготовки заданий или выпуска задания, служба пакетной службы возвращает код состояния HTTP 409.

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

azure_auth

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

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

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Job list preparation and release task status

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

HTTP

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

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

Код состояния:: 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=2024-07-01.20.0"
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
CloudJobListPreparationAndReleaseTaskStatusResult	Результат перечисления состояния задач подготовки заданий и выпуска заданий для задания.
ErrorCategory	Категория ошибки.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
JobPreparationAndReleaseTaskExecutionInformation	Состояние задач подготовки задания и выпуска заданий на вычислительном узле.
JobPreparationTaskExecutionInformation	Содержит сведения о выполнении задачи подготовки заданий на вычислительном узле.
JobPreparationTaskState	Текущее состояние задачи подготовки заданий на вычислительном узле.
JobReleaseTaskExecutionInformation	Содержит сведения о выполнении задачи выпуска задания на вычислительном узле.
JobReleaseTaskState	Текущее состояние задачи выпуска задания на вычислительном узле.
NameValuePair	Представляет пару "имя-значение".
TaskContainerExecutionInformation	Содержит сведения о контейнере, который выполняет задача.
TaskExecutionResult	Результат выполнения задачи.
TaskFailureInformation	Сведения о сбое задачи.

BatchError

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

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

BatchErrorDetail

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

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

CloudJobListPreparationAndReleaseTaskStatusResult

Результат перечисления состояния задач подготовки заданий и выпуска заданий для задания.

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

ErrorCategory

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

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

ErrorMessage

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

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

JobPreparationAndReleaseTaskExecutionInformation

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

Имя	Тип	Описание
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Сведения о состоянии выполнения задачи подготовки заданий на этом вычислительном узле.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Сведения о состоянии выполнения задачи выпуска задания на этом вычислительном узле. Это свойство задается только в том случае, если задача выпуска задания запущена на вычислительном узле.
nodeId	string	Идентификатор вычислительного узла, на который ссылается эта запись.
nodeUrl	string	URL-адрес вычислительного узла, на который ссылается эта запись.
poolId	string	Идентификатор пула, содержащего вычислительный узел, к которому относится эта запись.

JobPreparationTaskExecutionInformation

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

Имя	Тип	Описание
containerInfo	TaskContainerExecutionInformation	Сведения о контейнере, в котором выполняется задача. Это свойство задается только в том случае, если задача выполняется в контексте контейнера.
endTime	string	Время завершения задачи подготовки заданий. Это свойство задается только в том случае, если задача находится в состоянии "Завершено".
exitCode	integer	Код выхода программы, указанной в командной строке задачи. Этот параметр возвращается только в том случае, если задача находится в состоянии завершения. Код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что вы знаете соглашение о коде выхода, используемое процессом приложения. Обратите внимание, что код выхода также может быть создан операционной системой вычислительного узла, например при принудительном завершении процесса.
failureInfo	TaskFailureInformation	Сведения, описывающие сбой задачи, если таковые есть. Это свойство задается только в том случае, если задача находится в состоянии завершения и возникла ошибка.
lastRetryTime	string	Последнее время выполнения задачи подготовки задания. Это свойство задается только в том случае, если задача была извлечена (т. е. retryCount ненулево). При наличии это обычно совпадает с начальным временем, но может отличаться, если задача была перезапущена по причинам, отличным от повторных попыток; Например, если вычислительный узел был перезагружен во время повторных попыток, время начала обновляется, но последнее значение не является.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно "сбой", сведения о сбое можно найти в свойстве failureInfo.
retryCount	integer	Количество повторных попыток задачи пакетной службой. Ошибки приложения задач (ненулевая код выхода) извлекаются, предварительные ошибки обработки (не удалось выполнить задачу) и ошибки отправки файлов не извлекаются. Пакетная служба повторит задачу до предела, указанного ограничениями. Ошибки приложения задач (ненулевая код выхода) извлекаются, предварительные ошибки обработки (не удалось выполнить задачу) и ошибки отправки файлов не извлекаются. Пакетная служба повторит задачу до предела, указанного ограничениями.
startTime	string	Время запуска задачи. Если задача была перезапущена или извлечена, это самое последнее время запуска задачи.
state	JobPreparationTaskState	Текущее состояние задачи подготовки заданий на вычислительном узле.
taskRootDirectory	string	Корневой каталог задачи подготовки заданий на вычислительном узле. Этот путь можно использовать для получения файлов, созданных задачей, например файлов журналов.
taskRootDirectoryUrl	string	URL-адрес корневого каталога задачи подготовки заданий на вычислительном узле.

JobPreparationTaskState

Текущее состояние задачи подготовки заданий на вычислительном узле.

Имя	Тип	Описание
completed	string	Задача завершилась с кодом выхода 0, или задача исчерпала ограничение повторных попыток, или пакетная служба не смогла запустить задачу из-за ошибок подготовки задач (таких как сбои загрузки файла ресурсов).
running	string	Задача в настоящее время выполняется (включая повторную попытку).

JobReleaseTaskExecutionInformation

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

Имя	Тип	Описание
containerInfo	TaskContainerExecutionInformation	Сведения о контейнере, в котором выполняется задача. Это свойство задается только в том случае, если задача выполняется в контексте контейнера.
endTime	string	Время завершения задачи выпуска задания. Это свойство задается только в том случае, если задача находится в состоянии "Завершено".
exitCode	integer	Код выхода программы, указанной в командной строке задачи. Этот параметр возвращается только в том случае, если задача находится в состоянии завершения. Код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что вы знаете соглашение о коде выхода, используемое процессом приложения. Обратите внимание, что код выхода также может быть создан операционной системой вычислительного узла, например при принудительном завершении процесса.
failureInfo	TaskFailureInformation	Сведения, описывающие сбой задачи, если таковые есть. Это свойство задается только в том случае, если задача находится в состоянии завершения и возникла ошибка.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно "сбой", сведения о сбое можно найти в свойстве failureInfo.
startTime	string	Время запуска задачи. Если задача была перезапущена или извлечена, это самое последнее время запуска задачи.
state	JobReleaseTaskState	Текущее состояние задачи выпуска задания на вычислительном узле.
taskRootDirectory	string	Корневой каталог задачи выпуска задания на вычислительном узле. Этот путь можно использовать для получения файлов, созданных задачей, например файлов журналов.
taskRootDirectoryUrl	string	URL-адрес корневого каталога задачи выпуска задания на вычислительном узле.

JobReleaseTaskState

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

Имя	Тип	Описание
completed	string	Задача завершилась с кодом выхода 0, или задача исчерпала ограничение повторных попыток, или пакетная служба не смогла запустить задачу из-за ошибок подготовки задач (таких как сбои загрузки файла ресурсов).
running	string	Задача в настоящее время выполняется (включая повторную попытку).

NameValuePair

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

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

TaskContainerExecutionInformation

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

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

TaskExecutionResult

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

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

TaskFailureInformation

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

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

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

Job - List Preparation And Release Task Status

Параметры URI

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

Ответы

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

azure_auth

Области

Authorization

Примеры

Job list preparation and release task status

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

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

Определения

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Дополнительные ресурсы