Partilhar via

Job - Get Task Counts

Serviço:
Batch Service
Versão da API:
2024-07-01.20.0

Obtém as contagens de Tarefas para o Trabalho especificado.
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 bem-sucedidas ou com falha. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de tarefas, use uma consulta de lista.

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2024-07-01.20.0
Com parâmetros opcionais: 
GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
 path True

string

A URL base para todas as solicitações de serviço do 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. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

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

Name Necessá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 encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.
ocp-date

string (date-time-rfc1123)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name Tipo Description
200 OK

TaskCountsResult

Uma resposta que contém as contagens de Tarefas para o Trabalho especificado.

Cabeçalhos

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

O erro do serviço de lote.

Segurança

azure_auth

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

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Job get task counts

Pedido de amostra

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

Resposta da amostra

Código de estado:
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 Batch do Azure.
BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
ErrorMessage

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

A Tarefa conta para um Trabalho.
TaskCountsResult

A Tarefa e o TaskSlot contam para um Trabalho.
TaskSlotCounts

O TaskSlot conta para um trabalho.

BatchError

Object

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

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 descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

As informações adicionais incluídas com a resposta de erro.

ErrorMessage

Object

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

Name Tipo Description
lang

string

O código de idioma da mensagem de erro
value

string

O texto da mensagem.

TaskCounts

Object

A Tarefa conta para um Trabalho.

Name Tipo Description
active

integer (int32)

O número de Tarefas no estado ativo.
completed

integer (int32)

O número de Tarefas no estado concluído.
failed

integer (int32)

O número de tarefas que falharam. Uma tarefa falhará se seu resultado (encontrado na propriedade executionInfo) for 'falha'.
running

integer (int32)

O número de Tarefas no estado de execução ou preparação.
succeeded

integer (int32)

O número de Tarefas que tiveram êxito. Uma tarefa terá êxito se seu resultado (encontrado na propriedade executionInfo) for 'success'.

TaskCountsResult

Object

A Tarefa e o TaskSlot contam para um Trabalho.

Name Tipo Description
taskCounts

TaskCounts

O número de Tarefas por estado.
taskSlotCounts

TaskSlotCounts

O número de TaskSlots exigidos por Tarefas por estado.

TaskSlotCounts

Object

O TaskSlot conta para um trabalho.

Name Tipo Description
active

integer (int32)

O número de TaskSlots para tarefas ativas.
completed

integer (int32)

O número de TaskSlots para Tarefas concluídas.
failed

integer (int32)

O número de TaskSlots para tarefas com falha.
running

integer (int32)

O número de TaskSlots para executar tarefas.
succeeded

integer (int32)

O número de TaskSlots para tarefas bem-sucedidas.