Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Ottiene il numero di attività per il processo specificato.
I conteggi delle attività forniscono un conteggio delle attività in base allo stato attivo, in esecuzione o completato dell'attività e a un conteggio delle attività che hanno avuto esito positivo o non riuscito. Le attività nello stato di preparazione vengono conteggiate come in esecuzione. Si noti che i numeri restituiti potrebbero non essere sempre aggiornati. Se sono necessari conteggi delle attività esatte, usare una query di elenco.

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2023-11-01.18.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste di servizio Azure Batch.
jobId	path	True	string	ID del processo.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer int32	Tempo massimo per cui il server può trascorrere l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string uuid	Identità richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string date-time-rfc1123	Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome	Tipo	Descrizione
200 OK	TaskCountsResult	Risposta contenente il numero di attività per il processo specificato. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Errore dal servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

Job get task counts

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "taskCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  },
  "taskSlotCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  }
}

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
TaskCounts	L'attività conta per un processo.
TaskCountsResult	L'attività e TaskSlot conta per un processo.
TaskSlotCounts	TaskSlot conta per un processo.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	ErrorMessage	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 Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta all'errore.

ErrorMessage

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

Nome	Tipo	Descrizione
lang	string	Codice del linguaggio del messaggio di errore
value	string	Testo del messaggio.

TaskCounts

L'attività conta per un processo.

Nome	Tipo	Descrizione
active	integer	Numero di attività nello stato attivo.
completed	integer	Numero di attività nello stato completato.
failed	integer	Numero di attività non riuscite. Un'attività ha esito negativo se il risultato (trovato nella proprietà executionInfo) è "errore".
running	integer	Numero di attività in esecuzione o preparazione.
succeeded	integer	Numero di attività riuscite. Un'attività ha esito positivo se il risultato (trovato nella proprietà executionInfo) è "success".

TaskCountsResult

L'attività e TaskSlot conta per un processo.

Nome	Tipo	Descrizione
taskCounts	TaskCounts	Numero di attività per stato.
taskSlotCounts	TaskSlotCounts	Numero di taskSlot richiesti da Attività per stato.

TaskSlotCounts

TaskSlot conta per un processo.

Nome	Tipo	Descrizione
active	integer	Numero di TaskSlot per attività attive.
completed	integer	Numero di TaskSlot per attività completate.
failed	integer	Numero di taskSlot per attività non riuscite.
running	integer	Numero di TaskSlot per l'esecuzione di attività.
succeeded	integer	Numero di TaskSlot per attività riuscite.