Condividi tramite


Tasks - List Sub Tasks

Elenca tutti i sottotask associati al compito multi-istanze specificato.
Se il Task non è un Task multi-istanze, allora restituisce una collezione vuota.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

Endpoint dell'account Batch (ad esempio: https://batchaccount.eastus2.batch.azure.com).

jobId
path True

string

L'ID del lavoro.

taskId
path True

string

L'ID del compito.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

$select
query

string[]

Clausola di $select OData.

timeOut
query

integer (int32)

Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è superiore a 30, verrà utilizzato il valore predefinito.".

Intestazione della richiesta

Nome Necessario Tipo Descrizione
client-request-id

string

Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Indica se il server deve restituire l'ID richiesta client nella risposta.

ocp-date

string (date-time-rfc7231)

Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome Tipo Descrizione
200 OK

BatchTaskListSubtasksResult

La richiesta ha avuto esito positivo.

Intestazioni

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

BatchError

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome Descrizione
https://batch.core.windows.net//.default

Esempio

Task list subtasks

Esempio di richiesta

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


Risposta di esempio

{
  "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"
      }
    }
  ]
}

Definizioni

Nome Descrizione
BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

BatchErrorMessage

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

BatchErrorSourceCategory

BatchErrorSourceCategory enum

BatchNodeInfo

Informazioni sul nodo di calcolo in cui è stata eseguita un'attività.

BatchSubtask

Informazioni su una sottoattività di Azure Batch.

BatchSubtaskState

Enums BatchSubtaskState

BatchTaskContainerExecutionInfo

Contiene informazioni sul contenitore in cui è in esecuzione un'attività.

BatchTaskExecutionResult

Enum BatchTaskExecutionResult

BatchTaskFailureInfo

Informazioni su un errore di attività.

BatchTaskListSubtasksResult

Risultato dell'elenco delle sottoattività di un'attività.

NameValuePair

Rappresenta una coppia nome-valore.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.

message

BatchErrorMessage

Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

values

BatchErrorDetail[]

Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome Tipo Descrizione
key

string

Identificatore che specifica il significato della proprietà Value.

value

string

Informazioni aggiuntive incluse nella risposta di errore.

BatchErrorMessage

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome Tipo Descrizione
lang

string

Il codice linguistico del messaggio di errore.

value

string

Testo del messaggio.

BatchErrorSourceCategory

BatchErrorSourceCategory enum

Valore Descrizione
usererror

L'errore è dovuto a un problema dell'utente, come una configurazione errata (cattiva configurazione).

servererror

L'errore è dovuto a un problema interno del server.

BatchNodeInfo

Informazioni sul nodo di calcolo in cui è stata eseguita un'attività.

Nome Tipo Descrizione
affinityId

string

Un identificatore per il Nodo su cui veniva eseguito il Task, che può essere passato aggiungendo un Task per richiedere che il Task venga programmato su questo Nodo di Calcolo.

nodeId

string

L'ID del Nodo di Calcolo su cui veniva eseguito il Compito.

nodeUrl

string (uri)

L'URL del Nodo di Calcolo su cui veniva eseguito il Task.

poolId

string

L'ID del Pool su cui si svolgeva il Compito.

taskRootDirectory

string

La directory radice del compito sul nodo di calcolo.

taskRootDirectoryUrl

string (uri)

L'URL della directory radice del Task sul nodo di calcolo.

BatchSubtask

Informazioni su una sottoattività di Azure Batch.

Nome Tipo Descrizione
containerInfo

BatchTaskContainerExecutionInfo

Informazioni sul contenitore sotto cui il Task viene eseguito. Questa proprietà è impostata solo se il Task viene eseguito in un contesto container.

endTime

string (date-time)

Il momento in cui il sottocompito è stato completato. Questa proprietà è impostata solo se il sottocompito è nello stato Completato.

exitCode

integer (int32)

Il codice di uscita del programma specificato nella linea di comando del sottotask. Questa proprietà è impostata solo se il sottocompito è nello stato completato. In generale, il codice di uscita di un processo riflette la convenzione specifica implementata dallo sviluppatore dell'applicazione per quel processo. Se usi il valore del codice di uscita per prendere decisioni nel tuo codice, assicurati di conoscere la convenzione del codice di uscita usata dal processo di applicazione. Tuttavia, se il servizio Batch termina il sottotask (a causa del timeout o della terminazione utente tramite API) potresti vedere un codice di uscita definito dal sistema operativo.

failureInfo

BatchTaskFailureInfo

Informazioni che descrivono il fallimento del Compito, se ce ne sono. Questa proprietà viene impostata solo se il Compito è nello stato completato e ha incontrato un fallimento.

id

integer (int32)

L'ID del sottocompito.

nodeInfo

BatchNodeInfo

Informazioni sul Nodo di Calcolo su cui veniva eseguito il sottotask.

previousState

BatchSubtaskState

Lo stato precedente del sottocompito. Questa proprietà non è impostata se il sottocompito è nel suo stato iniziale di esecuzione.

previousStateTransitionTime

string (date-time)

Il momento in cui il sottocompito è entrato nello stato precedente. Questa proprietà non è impostata se il sottocompito è nel suo stato iniziale di esecuzione.

result

BatchTaskExecutionResult

Il risultato dell'esecuzione del Compito. Se il valore è 'fallito', allora i dettagli del guasto si trovano nella proprietà failureInfo.

startTime

string (date-time)

L'orario in cui il sottocompito ha iniziato a funzionare. Se il sotto-compito è stato riavviato o riprovato, questo è l'ultimo momento in cui il sottocompito ha iniziato a essere eseguito.

state

BatchSubtaskState

Lo stato attuale del sottocompito.

stateTransitionTime

string (date-time)

Il momento in cui il sottocompito è entrato nel suo stato attuale.

BatchSubtaskState

Enums BatchSubtaskState

Valore Descrizione
preparing

Il compito è stato assegnato a un Nodo di Calcolo, ma sta aspettando che un compito di Preparazione del Lavoro richiesto venga completato sul Nodo di Calcolo. Se il compito di Preparazione del Lavoro ha successo, il compito passerà a essere eseguito. Se il compito di preparazione del lavoro fallisce, il compito tornerà attivo e sarà idoneo ad essere assegnato a un diverso nodo di calcolo.

running

Il compito viene eseguito su un nodo di calcolo. Questo include la preparazione a livello di task, come scaricare file di risorse o distribuire Pacchetti specificati sul Task - non significa necessariamente che la riga di comando del Task abbia iniziato a essere eseguita.

completed

Il Compito non è più idoneo a essere eseguito, di solito perché è stato completato con successo o perché il Compito è stato completato senza successo e ha esaurito il limite di ritentativi. Un Compito viene inoltre segnato come completato se si è verificato un errore all'avvio del Compito, o quando il Compito è stato terminato.

BatchTaskContainerExecutionInfo

Contiene informazioni sul contenitore in cui è in esecuzione un'attività.

Nome Tipo Descrizione
containerId

string

L'ID del contenitore.

error

string

Informazioni dettagliate sugli errori sul contenitore. Questa è la stringa di errore dettagliata del servizio Docker, se disponibile. È equivalente al campo errore restituito da "docker inspect".

state

string

Lo stato del contenitore. Questo è lo stato del container secondo il servizio Docker. È equivalente al campo stato restituito da "docker inspect".

BatchTaskExecutionResult

Enum BatchTaskExecutionResult

Valore Descrizione
success

Il compito fu eseguito con successo.

failure

C'è stato un errore durante l'elaborazione del Compito. Il guasto potrebbe essersi verificato prima che il processo Task venisse avviato, mentre il processo Task era in esecuzione o dopo che il processo Task è stato concluso.

BatchTaskFailureInfo

Informazioni su un errore di attività.

Nome Tipo Descrizione
category

BatchErrorSourceCategory

La categoria dell'errore Task.

code

string

Un identificatore per l'errore Task. I codici sono invarianti e devono essere utilizzati a livello di codice.

details

NameValuePair[]

Un elenco di dettagli aggiuntivi relativi all'errore.

message

string

Un messaggio che descrive l'errore Task, pensato per essere adatto alla visualizzazione in un'interfaccia utente.

BatchTaskListSubtasksResult

Risultato dell'elenco delle sottoattività di un'attività.

Nome Tipo Descrizione
odata.nextLink

string (uri)

L'URL per ottenere il set di risultati successivo.

value

BatchSubtask[]

La lista dei sottocompiti.

NameValuePair

Rappresenta una coppia nome-valore.

Nome Tipo Descrizione
name

string

Il nome nella coppia nome-valore.

value

string

Il valore nella coppia nome-valore.