Job - List Preparation And Release Task Status

Service:

Batch Service

API Version:

2023-11-01.18.0

작업이 실행된 컴퓨팅 노드에서 지정된 작업에 대한 작업 준비 및 작업 릴리스 태스크의 실행 상태 나열합니다.
이 API는 작업 준비 또는 작업 릴리스 작업을 실행한 모든 컴퓨팅 노드에 상태 작업 준비 및 작업 릴리스 태스크를 반환합니다. 여기에는 풀에서 제거된 컴퓨팅 노드가 포함됩니다. 작업 준비 또는 작업 릴리스 태스크가 없는 작업에서 이 API가 호출되면 Batch 서비스는 JobPreparationTaskNotSpecified 오류 코드와 함께 HTTP 상태 코드 409(충돌)를 반환합니다.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
jobId	path	True	string	작업의 ID입니다.
api-version	query	True	string	클라이언트 API 버전.
$filter	query		string	OData $filter 절입니다. 이 필터를 생성하는 방법에 대한 자세한 내용은 을 참조하세요 https://docs.microsoft.com/en-us/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초입니다.

요청 헤더

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를 직접 호출하는 경우 명시적으로 설정합니다.

응답

Name	형식	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	작업 준비 및 작업 릴리스 작업 상태 목록이 포함된 응답입니다. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다. 작업 준비 또는 작업 릴리스 작업이 없는 작업에서 이 API가 호출되면 Batch 서비스는 HTTP 상태 코드 409를 반환합니다.

보안

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

예제

Job list preparation and release task status

Sample Request

HTTP

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

Sample Response

Status code:

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=2023-11-01.18.0"
}

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
CloudJobListPreparationAndReleaseTaskStatusResult	작업에 대한 작업 준비 및 작업 릴리스 작업의 상태 나열한 결과입니다.
ErrorCategory	오류의 범주입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
JobPreparationAndReleaseTaskExecutionInformation	컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업의 상태.
JobPreparationTaskExecutionInformation	컴퓨팅 노드에서 작업 준비 태스크를 실행하는 방법에 대한 정보를 포함합니다.
JobPreparationTaskState	컴퓨팅 노드의 작업 준비 태스크의 현재 상태입니다.
JobReleaseTaskExecutionInformation	컴퓨팅 노드에서 작업 릴리스 태스크를 실행하는 방법에 대한 정보를 포함합니다.
JobReleaseTaskState	컴퓨팅 노드에 있는 작업 릴리스 태스크의 현재 상태입니다.
NameValuePair	이름-값 쌍을 나타냅니다.
TaskContainerExecutionInformation	태스크가 실행 중인 컨테이너에 대한 정보를 포함합니다.
TaskExecutionResult	작업 실행의 결과입니다.
TaskFailureInformation	작업 실패에 대한 정보입니다.

BatchError

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

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

BatchErrorDetail

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

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

CloudJobListPreparationAndReleaseTaskStatusResult

작업에 대한 작업 준비 및 작업 릴리스 작업의 상태 나열한 결과입니다.

Name	형식	Description
odata.nextLink	string	다음 결과 집합을 가져올 URL입니다.
value	JobPreparationAndReleaseTaskExecutionInformation[]	작업 준비 및 작업 릴리스 태스크 실행 정보 목록입니다.

ErrorCategory

오류의 범주입니다.

Name	형식	Description
servererror	string	이 오류는 내부 서버 문제로 인해 발생합니다.
usererror	string	오류는 잘못된 구성과 같은 사용자 문제로 인해 발생합니다.

ErrorMessage

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

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

JobPreparationAndReleaseTaskExecutionInformation

컴퓨팅 노드에서 작업 준비 및 작업 릴리스 작업의 상태.

Name	형식	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	이 컴퓨팅 노드에서 작업 준비 태스크의 실행 상태 대한 정보입니다.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	이 컴퓨팅 노드에서 작업 릴리스 태스크의 실행 상태 대한 정보입니다. 이 속성은 작업 릴리스 태스크가 컴퓨팅 노드에서 실행된 경우에만 설정됩니다.
nodeId	string	이 항목이 참조하는 컴퓨팅 노드의 ID입니다.
nodeUrl	string	이 항목이 참조하는 컴퓨팅 노드의 URL입니다.
poolId	string	이 항목이 참조하는 컴퓨팅 노드를 포함하는 풀의 ID입니다.

JobPreparationTaskExecutionInformation

컴퓨팅 노드에서 작업 준비 태스크를 실행하는 방법에 대한 정보를 포함합니다.

Name	형식	Description
containerInfo	TaskContainerExecutionInformation	태스크가 실행 중인 컨테이너에 대한 정보입니다. 이 속성은 태스크가 컨테이너 컨텍스트에서 실행되는 경우에만 설정됩니다.
endTime	string	작업 준비 태스크가 완료된 시간입니다. 이 속성은 작업이 완료됨 상태인 경우에만 설정됩니다.
exitCode	integer	작업 명령줄에 지정된 프로그램의 종료 코드입니다. 이 매개 변수는 Task가 완료된 상태인 경우에만 반환됩니다. 프로세스의 종료 코드는 해당 프로세스에 대해 애플리케이션 개발자가 구현한 특정 규칙을 반영합니다. 종료 코드 값을 사용 하 여 코드에서 결정을 내릴 수 하는 경우 애플리케이션 프로세스에서 사용 하는 종료 코드 규칙을 알고 있다고 해야 합니다. 프로세스가 강제로 종료되는 경우와 같이 컴퓨팅 노드 운영 체제에서 종료 코드를 생성할 수도 있습니다.
failureInfo	TaskFailureInformation	작업 실패(있는 경우)를 설명하는 정보입니다. 이 속성은 작업이 완료된 상태이고 오류가 발생한 경우에만 설정됩니다.
lastRetryTime	string	작업 준비 태스크의 재시도가 실행되기 시작한 가장 최근의 시간입니다. 이 속성은 Task가 다시 시도된 경우에만 설정됩니다(예: retryCount가 0이 아닌 경우). 있는 경우 일반적으로 startTime과 동일하지만 다시 시도 이외의 이유로 작업이 다시 시작된 경우 다를 수 있습니다. 예를 들어 다시 시도하는 동안 컴퓨팅 노드가 다시 부팅된 경우 startTime은 업데이트되지만 lastRetryTime은 업데이트되지 않습니다.
result	TaskExecutionResult	작업 실행의 결과입니다. 값이 'failed'이면 failureInfo 속성에서 오류 세부 정보를 찾을 수 있습니다.
retryCount	integer	Batch 서비스에서 작업을 다시 시도한 횟수입니다. 작업 애플리케이션 오류(0이 아닌 종료 코드)가 다시 시도되고, 사전 처리 오류(작업을 실행할 수 없음) 및 파일 업로드 오류가 다시 시도되지 않습니다. Batch 서비스는 제약 조건에 지정된 제한까지 작업을 다시 시도합니다. 작업 애플리케이션 오류(0이 아닌 종료 코드)가 다시 시도되고, 사전 처리 오류(작업을 실행할 수 없음) 및 파일 업로드 오류가 다시 시도되지 않습니다. Batch 서비스는 제약 조건에 지정된 제한까지 작업을 다시 시도합니다.
startTime	string	태스크가 실행되기 시작한 시간입니다. 작업이 다시 시작되거나 다시 시도된 경우 태스크가 실행되기 시작한 가장 최근의 시간입니다.
state	JobPreparationTaskState	컴퓨팅 노드의 작업 준비 태스크의 현재 상태입니다.
taskRootDirectory	string	컴퓨팅 노드에 있는 작업 준비 태스크의 루트 디렉터리입니다. 이 경로를 사용하여 작업에서 만든 파일(예: 로그 파일)을 검색할 수 있습니다.
taskRootDirectoryUrl	string	컴퓨팅 노드에서 작업 준비 태스크의 루트 디렉터리에 대한 URL입니다.

JobPreparationTaskState

컴퓨팅 노드의 작업 준비 태스크의 현재 상태입니다.

Name	형식	Description
completed	string	태스크가 종료 코드 0으로 종료되었거나 태스크가 재시도 한도를 소진했거나 작업 준비 오류(예: 리소스 파일 다운로드 실패)로 인해 Batch 서비스가 작업을 시작할 수 없습니다.
running	string	작업이 현재 실행 중입니다(재시도 포함).

JobReleaseTaskExecutionInformation

컴퓨팅 노드에서 작업 릴리스 태스크를 실행하는 방법에 대한 정보를 포함합니다.

Name	형식	Description
containerInfo	TaskContainerExecutionInformation	태스크가 실행 중인 컨테이너에 대한 정보입니다. 이 속성은 태스크가 컨테이너 컨텍스트에서 실행되는 경우에만 설정됩니다.
endTime	string	작업 릴리스 태스크가 완료된 시간입니다. 이 속성은 작업이 완료됨 상태인 경우에만 설정됩니다.
exitCode	integer	작업 명령줄에 지정된 프로그램의 종료 코드입니다. 이 매개 변수는 Task가 완료된 상태인 경우에만 반환됩니다. 프로세스의 종료 코드는 해당 프로세스에 대해 애플리케이션 개발자가 구현한 특정 규칙을 반영합니다. 종료 코드 값을 사용 하 여 코드에서 결정을 내릴 수 하는 경우 애플리케이션 프로세스에서 사용 하는 종료 코드 규칙을 알고 있다고 해야 합니다. 프로세스가 강제로 종료되는 경우와 같이 컴퓨팅 노드 운영 체제에서 종료 코드를 생성할 수도 있습니다.
failureInfo	TaskFailureInformation	작업 실패(있는 경우)를 설명하는 정보입니다. 이 속성은 작업이 완료된 상태이고 오류가 발생한 경우에만 설정됩니다.
result	TaskExecutionResult	작업 실행의 결과입니다. 값이 'failed'이면 failureInfo 속성에서 오류 세부 정보를 찾을 수 있습니다.
startTime	string	태스크가 실행되기 시작한 시간입니다. 작업이 다시 시작되거나 다시 시도된 경우 태스크가 실행되기 시작한 가장 최근의 시간입니다.
state	JobReleaseTaskState	컴퓨팅 노드에 있는 작업 릴리스 태스크의 현재 상태입니다.
taskRootDirectory	string	컴퓨팅 노드에 있는 작업 릴리스 태스크의 루트 디렉터리입니다. 이 경로를 사용하여 작업에서 만든 파일(예: 로그 파일)을 검색할 수 있습니다.
taskRootDirectoryUrl	string	컴퓨팅 노드에서 작업 릴리스 태스크의 루트 디렉터리에 대한 URL입니다.

JobReleaseTaskState

컴퓨팅 노드에 있는 작업 릴리스 태스크의 현재 상태입니다.

Name	형식	Description
completed	string	태스크가 종료 코드 0으로 종료되었거나 태스크가 재시도 한도를 소진했거나 작업 준비 오류(예: 리소스 파일 다운로드 실패)로 인해 Batch 서비스가 작업을 시작할 수 없습니다.
running	string	작업이 현재 실행 중입니다(재시도 포함).

NameValuePair

이름-값 쌍을 나타냅니다.

Name	형식	Description
name	string	이름-값 쌍의 이름입니다.
value	string	이름-값 쌍의 값입니다.

TaskContainerExecutionInformation

태스크가 실행 중인 컨테이너에 대한 정보를 포함합니다.

Name	형식	Description
containerId	string	컨테이너의 ID입니다.
error	string	컨테이너에 대한 자세한 오류 정보입니다. 가능한 경우 Docker 서비스의 자세한 오류 문자열입니다. 이는 "docker inspect"에서 반환된 오류 필드와 동일합니다.
state	string	컨테이너의 상태입니다. Docker 서비스에 따른 컨테이너의 상태입니다. 이는 "docker inspect"에서 반환된 상태 필드와 동일합니다.

TaskExecutionResult

작업 실행의 결과입니다.

Name	형식	Description
failure	string	작업을 처리하는 동안 오류가 발생했습니다. 태스크 프로세스가 시작되기 전, 작업 프로세스가 실행되는 동안 또는 작업 프로세스가 종료된 후에 오류가 발생했을 수 있습니다.
success	string	작업이 성공적으로 실행되었습니다.

TaskFailureInformation

작업 실패에 대한 정보입니다.

Name	형식	Description
category	ErrorCategory	작업 오류의 범주입니다.
code	string	작업 오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	NameValuePair[]	오류와 관련된 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 작업 오류를 설명하는 메시지입니다.