Task - Terminate

  • Ссылка
Service:
Batch Service
API Version:
2022-01-01.15.0

Завершает указанную задачу.
После завершения задачи она переходит в завершенное состояние. Для задач с несколькими экземплярами операция завершения задачи применяется синхронно к основной задаче; Затем подзадачи завершаются асинхронно в фоновом режиме.

POST {batchUrl}/jobs/{jobId}/tasks/{taskId}/terminate?api-version=2022-01-01.15.0
With optional parameters: 
POST {batchUrl}/jobs/{jobId}/tasks/{taskId}/terminate?timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name In Required Type Description
batchUrl
 path True
  • string

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

Идентификатор задания, содержащего задачу.
taskId
 path True
  • string

Идентификатор завершаемой задачи.
api-version
 query True
  • string

Версия API клиента.
timeout
 query
  • integer
int32

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

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

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

Name Required Type Description
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 напрямую.
If-Match
  • string

Значение ETag, связанное с версией ресурса, известного клиенту. Операция выполняется только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match
  • string

Значение ETag, связанное с версией ресурса, известного клиенту. Операция выполняется только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
If-Modified-Since
  • string
date-time-rfc1123

Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе был изменен с указанного времени.
If-Unmodified-Since
  • string
date-time-rfc1123

Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс в службе не был изменен с указанного времени.

Ответы

Name Type Description
204 No Content

Запрос пакетной службы выполнен успешно.

Headers

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

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

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Task terminate

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks/taskId/terminate?api-version=2022-01-01.15.0

Sample Response

Status code:
204

Определения

BatchError

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

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

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

BatchError

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

Name Type Description
code
  • string

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

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

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

BatchErrorDetail

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

Name Type Description
key
  • string

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

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

ErrorMessage

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

Name Type Description
lang
  • string

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

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