Job - Get Task Counts

Riferimento

Servizio:: Batch Service

Versione API:: 2024-07-01.20.0

Ottiene il conteggio delle attività per il processo specificato.
I conteggi delle attività forniscono un conteggio delle attività in base allo stato attività attivo, in esecuzione o completato e a un conteggio delle attività riuscite o non riuscite. 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 di attività esatti, usare una query di elenco.

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2024-07-01.20.0

Con parametri facoltativi:

GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del 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 di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string (uuid)	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-rfc1123)	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

TaskCountsResult

Risposta contenente il conteggio delle attività per il processo specificato.

Intestazioni

client-request-id: string
request-id: string

Other Status Codes

Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

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

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Job get task counts

Esempio di richiesta

HTTP

GET account.region.batch.azure.com/jobs/jobId/taskcounts?api-version=2024-07-01.20.0

Risposta di esempio

Codice di stato:: 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 di Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
TaskCounts	L'attività viene conteggiato per un processo.
TaskCountsResult	L'oggetto Task e TaskSlot viene conteggiato per un processo.
TaskSlotCounts	TaskSlot conta per un processo.

BatchError

Object

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	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

Object

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.

ErrorMessage

Object

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

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

TaskCounts

Object

L'attività viene conteggiato per un processo.

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

TaskCountsResult

Object

L'oggetto Task e TaskSlot viene conteggiato per un processo.

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

TaskSlotCounts

Object

TaskSlot conta per un processo.

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