Partilhar via

Tasks - List Sub Tasks

Serviço:
Batch Service
Versão da API:
2025-06-01

Lista todas as subtarefas associadas à tarefa multi-instância especificada.
Se a Tarefa não for uma Tarefa multiinstância, então esta devolve uma coleção vazia.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01
Com parâmetros opcionais: 
GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01&timeOut={timeOut}&$select={$select}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
jobId
 path True

string

A identificação do trabalho.
taskId
 path True

string

A identificação da tarefa.
api-version
 query True

string

minLength: 1

A versão da API a utilizar para esta operação.
$select
 query

string[]

Uma cláusula OData $select.
timeOut
 query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name Necessário Tipo Description
client-request-id

string

A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.
ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name Tipo Description
200 OK

BatchTaskListSubtasksResult

O pedido foi bem-sucedido.

Cabeçalhos

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

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name Description
https://batch.core.windows.net//.default

Exemplos

Task list subtasks

Pedido de amostra

GET {endpoint}/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2025-06-01

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": 1,
      "startTime": "2025-09-06T06:59:16.3139271Z",
      "endTime": "2025-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2025-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2025-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": "2025-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2025-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"
      }
    }
  ]
}

Definições

Name Description
BatchError

Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchErrorSourceCategory

BatchErrorSourceCategory enums
BatchNodeInfo

Informações sobre o nó de computação no qual uma tarefa foi executada.
BatchSubtask

Informações sobre uma subtarefa do Lote do Azure.
BatchSubtaskState

BatchSubtaskState enums
BatchTaskContainerExecutionInfo

Contém informações sobre o contêiner que uma tarefa está executando.
BatchTaskExecutionResult

Enums BatchTaskExecutionResult
BatchTaskFailureInfo

Informações sobre uma falha de tarefa.
BatchTaskListSubtasksResult

O resultado da listagem das subtarefas de uma Tarefa.
NameValuePair

Representa um par nome-valor.

BatchError

Object

Uma resposta de erro recebida do serviço Batch do Azure.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

BatchErrorMessage

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

As informações adicionais incluídas com a resposta de erro.

BatchErrorMessage

Object

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.
value

string

O texto da mensagem.

BatchErrorSourceCategory

Enumeração

BatchErrorSourceCategory enums

Valor Description
usererror

O erro deve-se a um problema do utilizador, como uma má configuração.
servererror

O erro deve-se a um problema interno no servidor.

BatchNodeInfo

Object

Informações sobre o nó de computação no qual uma tarefa foi executada.

Name Tipo Description
affinityId

string

Um identificador para o Nó onde a Tarefa foi executada, que pode ser passado ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada nesse Nó de Computação.
nodeId

string

O ID do nó de computação onde a tarefa foi executada.
nodeUrl

string (uri)

A URL do Nó de Computação onde a Tarefa foi executada.
poolId

string

O ID do Pool onde a Tarefa decorria.
taskRootDirectory

string

O diretório raiz da tarefa no nó de computação.
taskRootDirectoryUrl

string (uri)

O URL para o diretório raiz da Tarefa no Nó de Computação.

BatchSubtask

Object

Informações sobre uma subtarefa do Lote do Azure.

Name Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Informação sobre o contentor sob o qual a Tarefa está a ser executada. Esta propriedade é definida apenas se a Tarefa for executada num contexto de contentor.
endTime

string (date-time)

O momento em que a subtarefa foi concluída. Esta propriedade é definida apenas se a subtarefa estiver no estado Completado.
exitCode

integer (int32)

O código de saída do programa especificado na linha de comandos da subtarefa. Esta propriedade é definida apenas se a subtarefa estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo programador da aplicação para esse processo. Se usar o valor do código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção do código de saída usada pelo processo de candidatura. No entanto, se o serviço Batch terminar a subtarefa (devido ao timeout ou à terminação do utilizador via API), pode aparecer um código de saída definido pelo sistema operativo.
failureInfo

BatchTaskFailureInfo

Informação que descreve a falha da Tarefa, se houver. Esta propriedade é definida apenas se a Tarefa estiver no estado concluído e tiver sofrido uma falha.
id

integer (int32)

O ID da subtarefa.
nodeInfo

BatchNodeInfo

Informação sobre o Nó de Computação onde a subtarefa corria.
previousState

BatchSubtaskState

O estado anterior da subtarefa. Esta propriedade não está definida se a subtarefa estiver no seu estado inicial de execução.
previousStateTransitionTime

string (date-time)

O momento em que a subtarefa entrou no seu estado anterior. Esta propriedade não está definida se a subtarefa estiver no seu estado inicial de execução.
result

BatchTaskExecutionResult

O resultado da execução da Tarefa. Se o valor for 'failed', então os detalhes da falha podem ser encontrados na propriedade failureInfo.
startTime

string (date-time)

A hora em que a subtarefa começou a funcionar. Se a subtarefa foi reiniciada ou tentada novamente, esta é a última vez em que a subtarefa começou a ser executada.
state

BatchSubtaskState

O estado atual da subtarefa.
stateTransitionTime

string (date-time)

O momento em que a subtarefa entrou no seu estado atual.

BatchSubtaskState

Enumeração

BatchSubtaskState enums

Valor Description
preparing

A Tarefa foi atribuída a um Nó de Computação, mas está à espera que uma Tarefa de Preparação de Trabalho obrigatória seja concluída no Nó de Computação. Se a Tarefa de Preparação de Tarefas for bem-sucedida, a Tarefa passará para a corrida. Se a Tarefa de Preparação de Tarefas falhar, a Tarefa voltará a estar ativa e será elegível para ser atribuída a um Nó de Computação diferente.
running

A tarefa está a correr num nó de computação. Isto inclui preparação ao nível da tarefa, como o download de ficheiros de recursos ou a implementação de Pacotes especificados na Tarefa – não significa necessariamente que a linha de comandos da Tarefa tenha começado a executar.
completed

A Tarefa já não é elegível para ser executada, normalmente porque a Tarefa foi concluída com sucesso, ou porque a Tarefa foi concluída sem sucesso e esgotou o seu limite de retentativas. Uma tarefa também é marcada como concluída se ocorrer um erro ao iniciar a tarefa, ou quando a tarefa foi terminada.

BatchTaskContainerExecutionInfo

Object

Contém informações sobre o contêiner que uma tarefa está executando.

Name Tipo Description
containerId

string

A identificação do contentor.
error

string

Informação detalhada sobre o erro do contentor. Esta é a cadeia de erros detalhada do serviço Docker, se disponível. É equivalente ao campo de erro devolvido por "docker inspect".
state

string

O estado do contentor. Este é o estado do contentor segundo o serviço Docker. É equivalente ao campo de estado devolvido por "docker inspect".

BatchTaskExecutionResult

Enumeração

Enums BatchTaskExecutionResult

Valor Description
success

A Tarefa correu com sucesso.
failure

Houve um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo Tarefa ser lançado, enquanto o processo Tarefa estava em execução, ou depois de o processo Tarefa ter terminado.

BatchTaskFailureInfo

Object

Informações sobre uma falha de tarefa.

Name Tipo Description
category

BatchErrorSourceCategory

A categoria do erro de tarefa.
code

string

Um identificador para o erro Tarefa. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details

NameValuePair[]

Uma lista de detalhes adicionais relacionados com o erro.
message

string

Uma mensagem que descreve o erro Tarefa, destinada a ser adequada para exibição numa interface de utilizador.

BatchTaskListSubtasksResult

Object

O resultado da listagem das subtarefas de uma Tarefa.

Name Tipo Description
odata.nextLink

string (uri)

O URL para obter o próximo conjunto de resultados.
value

BatchSubtask[]

A lista de subtarefas.

NameValuePair

Object

Representa um par nome-valor.

Name Tipo Description
name

string

O nome no par nome-valor.
value

string

O valor no par nome-valor.