Task - List Subtasks

Referens

Service:: Batch Service

API Version:: 2023-11-01.18.0

Visar en lista över alla underaktiviteter som är associerade med den angivna aktiviteten för flera instanser.
Om aktiviteten inte är en aktivitet med flera instanser returneras en tom samling.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
jobId	path	True	string	Jobbets ID.
taskId	path	True	string	ID:t för uppgiften.
api-version	query	True	string	Klient-API-version.
$select	query		string	En OData-$select-sats.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

Media Types: "application/json; odata=minimalmetadata"

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name

Typ

Description

200 OK

CloudTaskListSubtasksResult

Ett svar som innehåller listan över underaktiviteter.

Headers

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

Other Status Codes

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Task list subtasks

Sample Request

HTTP

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

Sample Response

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
CloudTaskListSubtasksResult	Resultatet av att lista underaktiviteterna för en aktivitet.
ComputeNodeInformation	Information om beräkningsnoden som en aktivitet kördes på.
ErrorCategory	Kategorin för felet.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
NameValuePair	Representerar ett namn/värde-par.
SubtaskInformation	Information om en Azure Batch underuppgift.
SubtaskState	Underuppgiftens tillstånd.
TaskContainerExecutionInformation	Innehåller information om containern som en uppgift körs i.
TaskExecutionResult	Resultatet av aktivitetskörningen.
TaskFailureInformation	Information om ett aktivitetsfel.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CloudTaskListSubtasksResult

Resultatet av att lista underaktiviteterna för en aktivitet.

Name	Typ	Description
value	SubtaskInformation[]	Listan över underaktiviteter.

ComputeNodeInformation

Information om beräkningsnoden som en aktivitet kördes på.

Name	Typ	Description
affinityId	string	En identifierare för noden som aktiviteten kördes på, som kan skickas när en aktivitet läggs till för att begära att aktiviteten schemaläggs på den här beräkningsnoden.
nodeId	string	ID:t för beräkningsnoden som aktiviteten kördes på.
nodeUrl	string	URL:en för beräkningsnoden som aktiviteten kördes på.
poolId	string	ID:t för poolen som aktiviteten kördes på.
taskRootDirectory	string	Rotkatalogen för aktiviteten på beräkningsnoden.
taskRootDirectoryUrl	string	URL:en till rotkatalogen för aktiviteten på beräkningsnoden.

ErrorCategory

Kategorin för felet.

Name	Typ	Description
servererror	string	Felet beror på ett internt serverproblem.
usererror	string	Felet beror på ett användarproblem, till exempel felkonfiguration.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

NameValuePair

Representerar ett namn/värde-par.

Name	Typ	Description
name	string	Namnet i namn/värde-paret.
value	string	Värdet i namn/värde-paret.

SubtaskInformation

Information om en Azure Batch underuppgift.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Information om containern som aktiviteten körs under. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tiden då underuppgiften slutfördes. Den här egenskapen anges endast om underuppgiften är i tillståndet Slutförd.
exitCode	integer	Slutkoden för programmet som angetts på underordnad kommandorad. Den här egenskapen anges endast om undernyckeln är i slutfört tillstånd. I allmänhet återspeglar slutkoden för en process den specifika konvention som implementerats av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den slutkodskonvention som används av programprocessen. Men om Batch-tjänsten avslutar underuppgiften (på grund av timeout eller användaravslut via API:et) kan du se en operativsystemdefinierad slutkod.
failureInfo	TaskFailureInformation	Information som beskriver aktivitetsfelet, om det finns någon. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
id	integer	ID:t för underuppgiften.
nodeInfo	ComputeNodeInformation	Information om beräkningsnoden som underuppgiften kördes på.
previousState	SubtaskState	Det tidigare tillståndet för underuppgiften. Den här egenskapen anges inte om undernyckeln är i sitt ursprungliga körningstillstånd.
previousStateTransitionTime	string	Den tidpunkt då underuppgiften övergick i sitt tidigare tillstånd. Den här egenskapen anges inte om undernyckeln är i sitt ursprungliga körningstillstånd.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
startTime	string	Tiden då undernyckeln började köras. Om underuppgiften har startats om eller gjorts om är det här den senaste gången som undernyckeln började köras.
state	SubtaskState	Det aktuella tillståndet för underuppgiften.
stateTransitionTime	string	Den tidpunkt då undernyckeln övergick till sitt aktuella tillstånd.

SubtaskState

Underuppgiftens tillstånd.

Name	Typ	Description
completed	string	Aktiviteten är inte längre berättigad att köras, vanligtvis på grund av att aktiviteten har slutförts, eller så har aktiviteten slutförts utan framgång och har uttömt sin återförsöksgräns. En aktivitet markeras också som slutförd om ett fel uppstod när aktiviteten startades eller när aktiviteten har avslutats.
preparing	string	Uppgiften har tilldelats till en beräkningsnod, men väntar på att en obligatorisk jobbförberedelseaktivitet ska slutföras på beräkningsnoden. Om jobbförberedelseaktiviteten lyckas flyttas aktiviteten till att köras. Om jobbförberedelseaktiviteten misslyckas återgår aktiviteten till aktiv och är berättigad att tilldelas till en annan beräkningsnod.
running	string	Uppgiften körs på en beräkningsnod. Detta inkluderar förberedelse på aktivitetsnivå, till exempel nedladdning av resursfiler eller distribution av paket som anges i aktiviteten – det betyder inte nödvändigtvis att kommandoraden Aktivitet har börjat köras.

TaskContainerExecutionInformation

Innehåller information om containern som en uppgift körs i.

Name	Typ	Description
containerId	string	Containerns ID.
error	string	Detaljerad felinformation om containern. Det här är den detaljerade felsträngen från Docker-tjänsten, om den är tillgänglig. Det motsvarar felfältet som returneras av "docker inspect".
state	string	Containerns tillstånd. Det här är containerns tillstånd enligt Docker-tjänsten. Det motsvarar statusfältet som returneras av "docker inspect".

TaskExecutionResult

Resultatet av aktivitetskörningen.

Name	Typ	Description
failure	string	Ett fel uppstod under bearbetningen av aktiviteten. Felet kan ha inträffat innan aktivitetsprocessen startades, medan aktivitetsprocessen kördes eller när aktivitetsprocessen avslutades.
success	string	Uppgiften kördes korrekt.

TaskFailureInformation

Information om ett aktivitetsfel.

Name	Typ	Description
category	ErrorCategory	Kategorin för aktivitetsfelet.
code	string	En identifierare för aktivitetsfelet. Koder är invarianta och är avsedda att användas programmatiskt.
details	NameValuePair[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver aktivitetsfelet, avsett att vara lämpligt för visning i ett användargränssnitt.