Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Pobiera liczbę zadań dla określonego zadania.
Liczba zadań zapewnia liczbę zadań przez aktywne, uruchomione lub ukończone zadanie oraz liczbę zadań, które zakończyły się powodzeniem lub niepowodzeniem. Zadania w stanie przygotowywania są liczone jako uruchomione. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb zadań, użyj zapytania listy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsługi Azure Batch.
jobId	path	True	string	Identyfikator zadania.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić wartość client-request-id w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TaskCountsResult	Odpowiedź zawierająca liczbę zadań dla określonego zadania. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
TaskCounts	Zadanie jest liczone dla zadania.
TaskCountsResult	Zadanie i zadanieSlot liczy się dla zadania.
TaskSlotCounts	ZadanieSlot liczy się dla zadania.

BatchError

Odpowiedź o błędzie odebrana z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

TaskCounts

Zadanie jest liczone dla zadania.

Nazwa	Typ	Opis
active	integer	Liczba zadań w stanie aktywnym.
completed	integer	Liczba zadań w stanie ukończonym.
failed	integer	Liczba zadań, które zakończyły się niepowodzeniem. Zadanie kończy się niepowodzeniem, jeśli jego wynik (znaleziony we właściwości executionInfo) to "niepowodzenie".
running	integer	Liczba zadań w stanie uruchomienia lub przygotowania.
succeeded	integer	Liczba zadań, które zakończyły się pomyślnie. Zadanie powiedzie się, jeśli jego wynik (znaleziony we właściwości executionInfo) to "success".

TaskCountsResult

Zadanie i zadanieSlot liczy się dla zadania.

Nazwa	Typ	Opis
taskCounts	TaskCounts	Liczba zadań na stan.
taskSlotCounts	TaskSlotCounts	Liczba zadańloty wymagane przez zadania na stan.

TaskSlotCounts

ZadanieSlot liczy się dla zadania.

Nazwa	Typ	Opis
active	integer	Liczba zadańzadaniowych dla aktywnych zadań.
completed	integer	Liczba zadańodanych dla ukończonych zadań.
failed	integer	Liczba zadań zakończonych niepowodzeniem.
running	integer	Liczba zadańlotów do uruchamiania zadań.
succeeded	integer	Liczba zadańzadaniowych dla zadań zakończonych powodzeniem.