Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtém as Contagens de tarefas para a Tarefa especificada.
As contagens de tarefas fornecem uma contagem das Tarefas por estado de tarefa ativa, em execução ou concluída, e uma contagem de Tarefas que foram bem-sucedidas ou falharam. As tarefas no estado de preparação são contadas como em execução. Tenha em atenção que os números devolvidos podem nem sempre estar atualizados. Se precisar de contagens de tarefas exatas, utilize uma 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 do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
jobId	path	True	string	O ID do Trabalho.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	TaskCountsResult	Uma resposta que contém as Contagens de tarefas para a Tarefa especificada. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
TaskCounts	A Tarefa conta para uma Tarefa.
TaskCountsResult	O Task and TaskSlot conta para uma Tarefa.
TaskSlotCounts	O TaskSlot conta para uma Tarefa.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta de erro.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

TaskCounts

A Tarefa conta para uma Tarefa.

Name	Tipo	Description
active	integer	O número de Tarefas no estado ativo.
completed	integer	O número de Tarefas no estado concluído.
failed	integer	O número de Tarefas que falharam. Uma Tarefa falha se o resultado (encontrado na propriedade executionInfo) for "falha".
running	integer	O número de Tarefas no estado de execução ou preparação.
succeeded	integer	O número de Tarefas que foram bem-sucedidas. Uma Tarefa é bem-sucedida se o resultado (encontrado na propriedade executionInfo) for "êxito".

TaskCountsResult

O Task and TaskSlot conta para uma Tarefa.

Name	Tipo	Description
taskCounts	TaskCounts	O número de Tarefas por estado.
taskSlotCounts	TaskSlotCounts	O número de TaskSlots exigido pelas Tarefas por estado.

TaskSlotCounts

O TaskSlot conta para uma Tarefa.

Name	Tipo	Description
active	integer	O número de TaskSlots para Tarefas ativas.
completed	integer	O número de TaskSlots para tarefas concluídas.
failed	integer	O número de TaskSlots para Tarefas falhadas.
running	integer	O número de TaskSlots para executar Tarefas.
succeeded	integer	O número de TaskSlots para Tarefas bem-sucedidas.