Delen via

Tasks - List Sub Tasks

Service:
Batch Service
API-versie:
2025-06-01

Geeft een lijst van alle subtaken die gekoppeld zijn aan de gespecificeerde multi-instance Task.
Als de Task geen multi-instance Task is, geeft dit een lege collectie terug.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com).
jobId
 path True

string

De ID van de baan.
taskId
 path True

string

De ID van de taak.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
$select
 query

string[]

Een OData-$select-component.
timeOut
 query

integer (int32)

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Aanvraagkoptekst

Name Vereist Type Description
client-request-id

string

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date

string (date-time-rfc7231)

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name Type Description
200 OK

BatchTaskListSubtasksResult

De aanvraag is voltooid.

Kopteksten

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

BatchError

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

Task list subtasks

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
      }
    }
  ]
}

Definities

Name Description
BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
BatchErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
BatchErrorSourceCategory

BatchErrorSourceCategory-enums
BatchNodeInfo

Informatie over het rekenknooppunt waarop een taak is uitgevoerd.
BatchSubtask

Informatie over een Azure Batch-subtaak.
BatchSubtaskState

BatchSubtaskState-enums
BatchTaskContainerExecutionInfo

Bevat informatie over de container die een taak uitvoert.
BatchTaskExecutionResult

BatchTaskExecutionResult enums
BatchTaskFailureInfo

Informatie over een taakfout.
BatchTaskListSubtasksResult

Het resultaat van het weergeven van de subtaken van een taak.
NameValuePair

Vertegenwoordigt een naam-waardepaar.

BatchError

Object

Er is een foutbericht ontvangen van de Azure Batch-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message

BatchErrorMessage

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values

BatchErrorDetail[]

Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Object

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name Type Description
key

string

Een id die de betekenis van de eigenschap Waarde aangeeft.
value

string

De aanvullende informatie die is opgenomen in het foutbericht.

BatchErrorMessage

Object

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht.
value

string

De tekst van het bericht.

BatchErrorSourceCategory

Opsomming

BatchErrorSourceCategory-enums

Waarde Description
usererror

De fout is het gevolg van een gebruikersprobleem, zoals een verkeerde configuratie.
servererror

De fout komt door een intern serverprobleem.

BatchNodeInfo

Object

Informatie over het rekenknooppunt waarop een taak is uitgevoerd.

Name Type Description
affinityId

string

Een identificatie voor de knoop waarop de taak draaide, die kan worden doorgegeven bij het toevoegen van een taak om te verzoeken dat de taak op deze rekenknoop wordt gepland.
nodeId

string

De ID van de rekenknoop waarop de taak draaide.
nodeUrl

string (uri)

De URL van de Compute Node waarop de Task draaide.
poolId

string

De ID van de Pool waarop de Taak liep.
taskRootDirectory

string

De rootmap van de Task op de Compute Node.
taskRootDirectoryUrl

string (uri)

De URL naar de rootmap van de Task op de Compute Node.

BatchSubtask

Object

Informatie over een Azure Batch-subtaak.

Name Type Description
containerInfo

BatchTaskContainerExecutionInfo

Informatie over de container waaronder de Taak wordt uitgevoerd. Deze eigenschap wordt alleen ingesteld als de Task in een containercontext draait.
endTime

string (date-time)

Het tijdstip waarop de subtaak werd voltooid. Deze eigenschap wordt alleen ingesteld als de subtaak zich in de Voltooide toestand bevindt.
exitCode

integer (int32)

De exitcode van het programma die op de subtaakcommandoregel wordt gespecificeerd. Deze eigenschap wordt alleen ingesteld als de subtaak in de voltooide toestand is. In het algemeen weerspiegelt de exitcode van een proces de specifieke conventie die door de applicatieontwikkelaar voor dat proces is geïmplementeerd. Als je de exitcodewaarde gebruikt om beslissingen te nemen in je code, zorg er dan voor dat je de exitcodeconventie kent die door het applicatieproces wordt gebruikt. Als de Batch-service echter de subtaak beëindigt (vanwege time-out of gebruikersbeëindiging via de API), kun je een door het besturingssysteem gedefinieerde exitcode zien.
failureInfo

BatchTaskFailureInfo

Informatie die de taakfaling beschrijft, indien aanwezig. Deze eigenschap wordt alleen ingesteld als de Taak zich in de voltooide toestand bevindt en een storing ondervindt.
id

integer (int32)

De ID van de subtaak.
nodeInfo

BatchNodeInfo

Informatie over de Compute Node waarop de subtaak draaide.
previousState

BatchSubtaskState

De vorige staat van de subtaak. Deze eigenschap wordt niet ingesteld als de subtaak in zijn initiële loopstaat is.
previousStateTransitionTime

string (date-time)

Het moment waarop de subtaak in zijn vorige staat kwam. Deze eigenschap wordt niet ingesteld als de subtaak in zijn initiële loopstaat is.
result

BatchTaskExecutionResult

Het resultaat van de uitvoering van de taak. Als de waarde 'failed' is, kunnen de details van de failure worden gevonden in de failureInfo-eigenschap.
startTime

string (date-time)

Het tijdstip waarop de subtaak begon te draaien. Als de subtaak opnieuw is opgestart of opnieuw geprobeerd, is dit de meest recente keer waarop de subtaak begon te draaien.
state

BatchSubtaskState

De huidige staat van de subtaak.
stateTransitionTime

string (date-time)

Het moment waarop de subtaak in zijn huidige staat kwam.

BatchSubtaskState

Opsomming

BatchSubtaskState-enums

Waarde Description
preparing

De taak is toegewezen aan een rekenknooppunt, maar wacht op een vereiste taakvoorbereidingstaak op de rekenknoop. Als de taak voor taakvoorbereiding slaagt, gaat de taak over naar het uitvoeren. Als de taak voorbereidingstaak faalt, keert de taak terug naar actief en komt in aanmerking om aan een andere rekenknoop toegewezen te worden.
running

De taak draait op een rekenknooppunt. Dit omvat taakniveauvoorbereiding, zoals het downloaden van resourcebestanden of het uitrollen van pakketten die op de taak zijn gespecificeerd – het betekent niet noodzakelijk dat de opdrachtregel van de taak al is begonnen met uitvoeren.
completed

De taak is niet langer bevoegd om uit te voeren, meestal omdat de taak succesvol is voltooid, of omdat de taak zonder succes is voltooid en zijn herkansingslimiet is uitgeput. Een taak wordt ook als voltooid gemarkeerd als er een fout is opgetreden bij het starten van de taak, of wanneer de taak is beëindigd.

BatchTaskContainerExecutionInfo

Object

Bevat informatie over de container die een taak uitvoert.

Name Type Description
containerId

string

De ID van de container.
error

string

Gedetailleerde foutinformatie over de container. Dit is de gedetailleerde foutreeks van de Docker-service, indien beschikbaar. Het is equivalent aan het foutveld dat door "docker inspect" wordt teruggegeven.
state

string

De staat van de container. Dit is de staat van de container volgens de Docker-service. Het is gelijkwaardig aan het statusveld dat door "docker inspect" wordt teruggegeven.

BatchTaskExecutionResult

Opsomming

BatchTaskExecutionResult enums

Waarde Description
success

De Task liep succesvol.
failure

Er was een fout tijdens de verwerking van de Taak. De storing kan zijn opgetreden voordat het Taakproces werd gestart, terwijl het Taakproces werd uitgevoerd, of nadat het Taakproces was afgesloten.

BatchTaskFailureInfo

Object

Informatie over een taakfout.

Name Type Description
category

BatchErrorSourceCategory

De categorie van de taakfout.
code

string

Een identificatie voor de Taakfout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details

NameValuePair[]

Een lijst met aanvullende details gerelateerd aan de fout.
message

string

Een bericht dat de Taakfout beschrijft, bedoeld om geschikt te zijn voor weergave in een gebruikersinterface.

BatchTaskListSubtasksResult

Object

Het resultaat van het weergeven van de subtaken van een taak.

Name Type Description
odata.nextLink

string (uri)

De URL om de volgende reeks resultaten te krijgen.
value

BatchSubtask[]

De lijst met subtaken.

NameValuePair

Object

Vertegenwoordigt een naam-waardepaar.

Name Type Description
name

string

De naam in het naam-waarde-paar.
value

string

De waarde in het naam-waarde-paar.