Job - Terminate
지정된 작업을 종료하여 완료된 것으로 표시합니다.
종결 작업 요청이 수신되면 Batch 서비스는 작업을 종료 상태로 설정합니다. 그런 다음 Batch 서비스는 작업과 연결된 실행 중인 작업을 종료하고 필요한 작업 릴리스 작업을 실행합니다. 그런 다음 작업이 완료된 상태로 이동합니다. 작업에 활성 상태의 작업이 있는 경우 활성 상태로 유지됩니다. 작업이 종료되면 새 작업을 추가할 수 없으며 나머지 활성 작업은 예약되지 않습니다.
POST {batchUrl}/jobs/{jobId}/terminate?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/terminate?timeout={timeout}&api-version=2023-11-01.18.0
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
batch
|
path | True |
string |
모든 Azure Batch 서비스 요청에 대한 기본 URL입니다. |
job
|
path | True |
string |
종료할 작업의 ID입니다. |
api-version
|
query | True |
string |
클라이언트 API 버전. |
timeout
|
query |
integer int32 |
서버가 요청을 처리하는 데 소요할 수 있는 최대 시간(초)입니다. 기본값은 30초입니다. |
요청 헤더
Media Types: "application/json; odata=minimalmetadata"
Name | 필수 | 형식 | Description |
---|---|---|---|
client-request-id |
string uuid |
9C4D50EE-2D56-4CD3-8152-34347DC9F2B0과 같은 장식이 없는 GUID 형식의 호출자 생성 요청 ID입니다. |
|
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 |
클라이언트에 알려진 리소스의 마지막 수정 시간을 나타내는 타임스탬프입니다. 지정된 시간 이후 서비스의 리소스가 수정되지 않은 경우에만 작업이 수행됩니다. |
요청 본문
Media Types: "application/json; odata=minimalmetadata"
Name | 형식 | Description |
---|---|---|
terminateReason |
string |
작업의 TerminateReason으로 표시할 텍스트입니다. 기본값은 'UserTerminate'입니다. |
응답
Name | 형식 | Description |
---|---|---|
202 Accepted |
Batch 서비스에 대한 요청이 성공했습니다. 헤더
|
|
Other Status Codes |
Batch 서비스의 오류입니다. |
보안
azure_auth
OAuth 2.0 인증 코드 흐름 Microsoft Entra
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
Authorization
형식:
apiKey
In(다음 안에):
header
예제
Job terminate
샘플 요청
POST account.region.batch.azure.com/jobs/jobId/terminate?api-version=2023-11-01.18.0
{
"terminateReason": "User supplied termination reason"
}
샘플 응답
정의
Name | Description |
---|---|
Batch |
Azure Batch 서비스에서 받은 오류 응답입니다. |
Batch |
Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다. |
Error |
Azure Batch 오류 응답에서 받은 오류 메시지입니다. |
Job |
작업을 종료할 때의 옵션입니다. |
BatchError
Azure Batch 서비스에서 받은 오류 응답입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다. |
message |
사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다. |
|
values |
오류에 대한 추가 세부 정보가 포함된 키-값 쌍의 컬렉션입니다. |
BatchErrorDetail
Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
Name | 형식 | Description |
---|---|---|
key |
string |
Value 속성의 의미를 지정하는 식별자입니다. |
value |
string |
오류 응답에 포함된 추가 정보입니다. |
ErrorMessage
Azure Batch 오류 응답에서 받은 오류 메시지입니다.
Name | 형식 | Description |
---|---|---|
lang |
string |
오류 메시지의 언어 코드 |
value |
string |
메시지의 텍스트입니다. |
JobTerminateParameter
작업을 종료할 때의 옵션입니다.
Name | 형식 | Description |
---|---|---|
terminateReason |
string |
작업의 TerminateReason으로 표시할 텍스트입니다. 기본값은 'UserTerminate'입니다. |