Job - Get Task Counts

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtém as contagens de tarefas para o trabalho especificado.
As contagens de tarefas fornecem uma contagem do estado Tarefas ativas, em execução ou concluídas, e uma contagem de Tarefas que tiveram êxito ou falharam. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados nem sempre podem estar atualizados. Se você precisar de contagens exatas de tarefas, use 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 de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
jobId	path	True	string	A ID do Trabalho.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar a client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome

Tipo

Description

200 OK

TaskCountsResult

Uma resposta que contém as contagens de tarefas para o trabalho especificado.

Headers

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

Other Status Codes

O erro do serviço do Lote.

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

Nome	Description
user_impersonation	Representar sua conta de usuário

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

Nome	Description
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
TaskCounts	A Tarefa conta para um Trabalho.
TaskCountsResult	O Task e TaskSlot conta para um Trabalho.
TaskSlotCounts	O TaskSlot conta para um Trabalho.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
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ído em uma resposta de erro Lote do Azure.

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

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.

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

TaskCounts

A Tarefa conta para um Trabalho.

Nome	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 falhará se o resultado (encontrado na propriedade executionInfo) for 'failure'.
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 terá êxito se o resultado (encontrado na propriedade executionInfo) for "êxito".

TaskCountsResult

O Task e TaskSlot conta para um Trabalho.

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

TaskSlotCounts

O TaskSlot conta para um Trabalho.

Nome	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 com falha.
running	integer	O número de TaskSlots para executar Tarefas.
succeeded	integer	O número de TaskSlots para Tarefas bem-sucedidas.