Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtiene los recuentos de tareas para el trabajo especificado.
Los recuentos de tareas proporcionan un recuento de las tareas por estado de tarea activo, en ejecución o completado, y un recuento de tareas que se han realizado correctamente o con errores. Las tareas del estado de preparación se cuentan como en ejecución. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de tareas, use una consulta de lista.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
jobId	path	True	string	Identificador del trabajo.
api-version	query	True	string	Versión de la API de cliente.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
client-request-id		string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date		string date-time-rfc1123	Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	TaskCountsResult	Respuesta que contiene los recuentos de tareas para el trabajo especificado. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

Microsoft Entra flujo de código de autenticación de OAuth 2.0

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

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

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

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
TaskCounts	La tarea cuenta para un trabajo.
TaskCountsResult	La tarea y taskSlot cuentan para un trabajo.
TaskSlotCounts	TaskSlot cuenta para un trabajo.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	Información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

TaskCounts

La tarea cuenta para un trabajo.

Nombre	Tipo	Description
active	integer	Número de tareas en estado activo.
completed	integer	Número de tareas en el estado completado.
failed	integer	Número de tareas que no se pudieron realizar. Se produce un error en una tarea si su resultado (encontrado en la propiedad executionInfo) es 'failure'.
running	integer	Número de tareas en el estado en ejecución o preparación.
succeeded	integer	Número de tareas que se realizaron correctamente. Una tarea se realiza correctamente si su resultado (que se encuentra en la propiedad executionInfo) es "correcto".

TaskCountsResult

La tarea y taskSlot cuentan para un trabajo.

Nombre	Tipo	Description
taskCounts	TaskCounts	Número de tareas por estado.
taskSlotCounts	TaskSlotCounts	Número de taskSlots requeridos por tareas por estado.

TaskSlotCounts

TaskSlot cuenta para un trabajo.

Nombre	Tipo	Description
active	integer	Número de taskSlots para tareas activas.
completed	integer	Número de taskSlots para tareas completadas.
failed	integer	Número de taskSlots para tareas con errores.
running	integer	Número de taskSlots para ejecutar tareas.
succeeded	integer	Número de taskSlots para las tareas realizadas correctamente.