Job - Get Task Counts

Service:

Batch Service

Version d'API:

2023-11-01.18.0

Obtient le nombre de tâches pour le travail spécifié.
Le nombre de tâches fournit un nombre de tâches par état de tâche actif, en cours d’exécution ou terminé, ainsi qu’un nombre de tâches qui ont réussi ou échoué. Les tâches à l’état de préparation sont comptabilisées comme en cours d’exécution. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de tâches, utilisez une requête de liste.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
jobId	path	True	string	ID du travail.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date		string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.

Réponses

Nom	Type	Description
200 OK	TaskCountsResult	Réponse contenant les nombres de tâches pour le travail spécifié. En-têtes client-request-id: string request-id: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
Dans: header

Exemples

Job get task counts

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
TaskCounts	Nombre de tâches pour un travail.
TaskCountsResult	Le nombre de tâches et de taskSlot pour un travail.
TaskSlotCounts	Le taskSlot compte pour un travail.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

TaskCounts

Nombre de tâches pour un travail.

Nom	Type	Description
active	integer	Nombre de tâches dans l’état actif.
completed	integer	Nombre de tâches dans l’état terminé.
failed	integer	Nombre de tâches ayant échoué. Une tâche échoue si son résultat (trouvé dans la propriété executionInfo) est « failure ».
running	integer	Nombre de tâches en cours d’exécution ou de préparation.
succeeded	integer	Nombre de tâches qui ont réussi. Une tâche réussit si son résultat (trouvé dans la propriété executionInfo) est « success ».

TaskCountsResult

Le nombre de tâches et de taskSlot pour un travail.

Nom	Type	Description
taskCounts	TaskCounts	Nombre de tâches par état.
taskSlotCounts	TaskSlotCounts	Nombre de taskSlots requis par Tasks par état.

TaskSlotCounts

Le taskSlot compte pour un travail.

Nom	Type	Description
active	integer	Nombre de taskSlots pour les tâches actives.
completed	integer	Nombre de taskSlots pour les tâches terminées.
failed	integer	Nombre de taskSlots pour les tâches ayant échoué.
running	integer	Nombre de taskSlots pour l’exécution des tâches.
succeeded	integer	Nombre de taskSlots pour les tâches réussies.