Pool - Remove Nodes

Service:

Batch Service

API Version:

2023-11-01.18.0

지정된 풀에서 컴퓨팅 노드를 제거합니다.
이 작업은 풀의 할당 상태가 안정적일 때만 실행할 수 있습니다. 이 작업이 실행되면 할당 상태가 안정에서 크기 조정으로 변경됩니다. 각 요청은 최대 100개의 노드를 제거할 수 있습니다.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
poolId	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
nodeList	True	string[]	지정된 풀에서 제거할 컴퓨팅 노드의 ID가 포함된 목록입니다. 요청당 최대 100개의 노드를 제거할 수 있습니다.
nodeDeallocationOption		ComputeNodeDeallocationOption	할당 취소를 위해 선택한 후 컴퓨팅 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다. 기본값은 requeue입니다.
resizeTimeout		string	풀에 대한 컴퓨팅 노드 제거 시간 제한입니다. 기본값은 15분입니다. 최소값은 5분입니다. 5분 미만의 값을 지정하면 Batch 서비스가 오류를 반환합니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 400(잘못된 요청)입니다.

응답

Name	형식	Description
202 Accepted		Batch 서비스에 대한 요청이 성공했습니다. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다.

보안

azure_auth

OAuth 2.0 인증 코드 흐름 Microsoft Entra

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

Authorization

Type: apiKey
In: header

예제

Pool remove nodes

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2023-11-01.18.0



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Sample Response

Status code:

202

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
ComputeNodeDeallocationOption	할당 취소를 위해 선택한 후 컴퓨팅 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
NodeRemoveParameter	풀에서 컴퓨팅 노드를 제거하는 옵션입니다.

BatchError

Azure Batch 서비스에서 받은 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	ErrorMessage	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
values	BatchErrorDetail[]	오류에 대한 추가 세부 정보가 포함된 키-값 쌍의 컬렉션입니다.

BatchErrorDetail

Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.

Name	형식	Description
key	string	Value 속성의 의미를 지정하는 식별자입니다.
value	string	오류 응답에 포함된 추가 정보입니다.

ComputeNodeDeallocationOption

할당 취소를 위해 선택한 후 컴퓨팅 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.

Name	형식	Description
requeue	string	실행 중인 작업 프로세스를 종료하고 태스크를 다시 큐에 추가합니다. 컴퓨팅 노드를 사용할 수 있으면 작업이 다시 실행됩니다. 작업이 종료되는 즉시 컴퓨팅 노드를 제거합니다.
retaineddata	string	현재 실행 중인 작업을 완료하도록 허용한 다음 모든 작업 데이터 보존 기간이 만료되기를 기다립니다. 대기하는 동안 새 작업을 예약하지 않습니다. 모든 작업 보존 기간이 만료된 경우 컴퓨팅 노드를 제거합니다.
taskcompletion	string	현재 실행 중인 작업을 완료하도록 허용합니다. 대기하는 동안 새 작업을 예약하지 않습니다. 모든 작업이 완료되면 컴퓨팅 노드를 제거합니다.
terminate	string	실행 중인 작업을 종료합니다. 작업이 종료되었음을 나타내는 failureInfo로 완료되고 다시 실행되지 않습니다. 작업이 종료되는 즉시 컴퓨팅 노드를 제거합니다.

ErrorMessage

Azure Batch 오류 응답에서 받은 오류 메시지입니다.

Name	형식	Description
lang	string	오류 메시지의 언어 코드
value	string	메시지의 텍스트입니다.

NodeRemoveParameter

풀에서 컴퓨팅 노드를 제거하는 옵션입니다.

Name	형식	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	할당 취소를 위해 선택한 후 컴퓨팅 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다. 기본값은 requeue입니다.
nodeList	string[]	지정된 풀에서 제거할 컴퓨팅 노드의 ID가 포함된 목록입니다. 요청당 최대 100개의 노드를 제거할 수 있습니다.
resizeTimeout	string	풀에 대한 컴퓨팅 노드 제거 시간 제한입니다. 기본값은 15분입니다. 최소값은 5분입니다. 5분 미만의 값을 지정하면 Batch 서비스가 오류를 반환합니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 400(잘못된 요청)입니다.