Task - List Subtasks

참조

서비스:: Batch Service

API 버전:: 2023-11-01.18.0

지정된 다중 instance 작업과 연결된 모든 하위 작업을 나열합니다.
Task가 다중 instance 작업이 아니면 빈 컬렉션이 반환됩니다.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2023-11-01.18.0

선택적 매개 변수:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?$select={$select}&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입니다.
taskId	path	True	string	작업의 ID입니다.
api-version	query	True	string	클라이언트 API 버전.
$select	query		string	OData $select 절입니다.
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	CloudTaskListSubtasksResult	하위 작업 목록을 포함하는 응답입니다. 헤더 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다.

Name

형식

Description

200 OK

CloudTaskListSubtasksResult

하위 작업 목록을 포함하는 응답입니다.

헤더

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

Other Status Codes

BatchError

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

예제

Task list subtasks

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "id": 1,
      "startTime": "2016-09-06T06:59:16.3139271Z",
      "endTime": "2016-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2016-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z",
      "exitCode": 0,
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_3-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_3-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1"
      }
    },
    {
      "id": 2,
      "startTime": "2016-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2016-09-06T06:59:16.9702844Z",
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_2-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_2-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2"
      }
    }
  ]
}

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
CloudTaskListSubtasksResult	작업의 하위 작업을 나열한 결과입니다.
ComputeNodeInformation	태스크가 실행된 컴퓨팅 노드에 대한 정보입니다.
ErrorCategory	오류의 범주입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
NameValuePair	이름-값 쌍을 나타냅니다.
SubtaskInformation	Azure Batch 하위 작업에 대한 정보입니다.
SubtaskState	하위 작업의 상태입니다.
TaskContainerExecutionInformation	태스크가 실행 중인 컨테이너에 대한 정보를 포함합니다.
TaskExecutionResult	작업 실행의 결과입니다.
TaskFailureInformation	작업 실패에 대한 정보입니다.

BatchError

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

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

BatchErrorDetail

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

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

CloudTaskListSubtasksResult

작업의 하위 작업을 나열한 결과입니다.

Name	형식	Description
value	SubtaskInformation[]	하위 작업 목록입니다.

ComputeNodeInformation

태스크가 실행된 컴퓨팅 노드에 대한 정보입니다.

Name	형식	Description
affinityId	string	태스크가 실행된 노드에 대한 식별자이며, 태스크를 추가할 때 이 컴퓨팅 노드에서 태스크를 예약하도록 요청할 때 전달할 수 있습니다.
nodeId	string	태스크가 실행된 컴퓨팅 노드의 ID입니다.
nodeUrl	string	태스크가 실행된 컴퓨팅 노드의 URL입니다.
poolId	string	태스크가 실행된 풀의 ID입니다.
taskRootDirectory	string	컴퓨팅 노드에 있는 작업의 루트 디렉터리입니다.
taskRootDirectoryUrl	string	컴퓨팅 노드에서 태스크의 루트 디렉터리에 대한 URL입니다.

ErrorCategory

오류의 범주입니다.

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

ErrorMessage

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

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

NameValuePair

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

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

SubtaskInformation

Azure Batch 하위 작업에 대한 정보입니다.

Name	형식	Description
containerInfo	TaskContainerExecutionInformation	태스크가 실행 중인 컨테이너에 대한 정보입니다. 이 속성은 태스크가 컨테이너 컨텍스트에서 실행되는 경우에만 설정됩니다.
endTime	string	하위 작업이 완료된 시간입니다. 이 속성은 하위 작업이 완료됨 상태인 경우에만 설정됩니다.
exitCode	integer	하위 작업 명령줄에 지정된 프로그램의 종료 코드입니다. 이 속성은 하위 작업이 완료된 상태인 경우에만 설정됩니다. 일반적으로 프로세스의 종료 코드는 해당 프로세스에 대해 애플리케이션 개발자가 구현한 특정 규칙을 반영합니다. 종료 코드 값을 사용 하 여 코드에서 결정을 내릴 수 하는 경우 애플리케이션 프로세스에서 사용 하는 종료 코드 규칙을 알고 있다고 해야 합니다. 그러나 Batch 서비스가 하위 작업을 종료하는 경우(시간 제한 또는 API를 통한 사용자 종료로 인해) 운영 체제 정의 종료 코드가 표시될 수 있습니다.
failureInfo	TaskFailureInformation	작업 실패(있는 경우)를 설명하는 정보입니다. 이 속성은 작업이 완료된 상태이고 오류가 발생한 경우에만 설정됩니다.
id	integer	하위 작업의 ID입니다.
nodeInfo	ComputeNodeInformation	하위 작업이 실행된 컴퓨팅 노드에 대한 정보입니다.
previousState	SubtaskState	하위 작업의 이전 상태입니다. 하위 작업이 초기 실행 상태인 경우 이 속성이 설정되지 않습니다.
previousStateTransitionTime	string	하위 작업이 이전 상태로 진입한 시간입니다. 하위 작업이 초기 실행 상태인 경우 이 속성이 설정되지 않습니다.
result	TaskExecutionResult	작업 실행의 결과입니다. 값이 'failed'이면 failureInfo 속성에서 오류 세부 정보를 찾을 수 있습니다.
startTime	string	하위 작업이 실행되기 시작한 시간입니다. 하위 작업이 다시 시작되거나 다시 시도된 경우 하위 작업이 실행되기 시작한 가장 최근의 시간입니다.
state	SubtaskState	하위 작업의 현재 상태입니다.
stateTransitionTime	string	하위 작업이 현재 상태를 입력한 시간입니다.

SubtaskState

하위 작업의 상태입니다.

Name	형식	Description
completed	string	태스크가 성공적으로 완료되었거나 태스크가 실패하고 재시도 한도를 소진했기 때문에 태스크를 더 이상 실행할 수 없습니다. 태스크를 시작하는 동안 오류가 발생했거나 태스크가 종료된 경우에도 작업이 완료된 것으로 표시됩니다.
preparing	string	태스크가 컴퓨팅 노드에 할당되었지만 컴퓨팅 노드에서 필요한 작업 준비 태스크가 완료되길 기다리고 있습니다. 작업 준비 태스크가 성공하면 태스크가 실행 중으로 이동합니다. 작업 준비 태스크가 실패하면 작업이 활성 상태로 돌아가고 다른 컴퓨팅 노드에 할당될 수 있습니다.
running	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	사용자 인터페이스에 표시하기에 적합한 작업 오류를 설명하는 메시지입니다.

다음을 통해 공유

Task - List Subtasks

URI 매개 변수

요청 헤더

응답

보안

azure_auth

범위

Authorization

예제

Task list subtasks

샘플 요청

샘플 응답

정의

BatchError

BatchErrorDetail

CloudTaskListSubtasksResult

ComputeNodeInformation

ErrorCategory

ErrorMessage

NameValuePair

SubtaskInformation

SubtaskState

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

추가 리소스