Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Mendapatkan jumlah Tugas untuk Pekerjaan yang ditentukan.
Jumlah tugas menyediakan hitungan Tugas dengan status Tugas aktif, berjalan, atau selesai, dan hitungan Tugas yang berhasil atau gagal. Tugas dalam status persiapan dihitung sebagai berjalan. Perhatikan bahwa angka yang dikembalikan mungkin tidak selalu diperbarui. Jika Anda memerlukan jumlah tugas yang tepat, gunakan kueri daftar.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
batchUrl	path	True	string	URL dasar untuk semua permintaan layanan Azure Batch.
jobId	path	True	string	ID Pekerjaan.
api-version	query	True	string	Versi API Klien.
timeout	query		integer int32	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik.

Header Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string uuid	Identitas permintaan yang dihasilkan pemanggil, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Apakah server harus mengembalikan client-request-id dalam respons.
ocp-date		string date-time-rfc1123	Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Respons

Nama	Jenis	Deskripsi
200 OK	TaskCountsResult	Respons yang berisi jumlah Tugas untuk Pekerjaan yang ditentukan. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Kesalahan dari layanan Batch.

Keamanan

azure_auth

Microsoft Entra alur kode autentikasi OAuth 2.0

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

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

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
TaskCounts	Tugas dihitung untuk Pekerjaan.
TaskCountsResult	Tugas dan TaskSlot dihitung untuk Pekerjaan.
TaskSlotCounts	TaskSlot dihitung untuk Pekerjaan.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
message	ErrorMessage	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	BatchErrorDetail[]	Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
lang	string	Kode bahasa pesan kesalahan
value	string	Teks pesan.

TaskCounts

Tugas dihitung untuk Pekerjaan.

Nama	Jenis	Deskripsi
active	integer	Jumlah Tugas dalam status aktif.
completed	integer	Jumlah Tugas dalam status selesai.
failed	integer	Jumlah Tugas yang gagal. Tugas gagal jika hasilnya (ditemukan di properti executionInfo) adalah 'kegagalan'.
running	integer	Jumlah Tugas dalam status berjalan atau mempersiapkan.
succeeded	integer	Jumlah Tugas yang berhasil. Tugas berhasil jika hasilnya (ditemukan di properti executionInfo) adalah 'sukses'.

TaskCountsResult

Tugas dan TaskSlot dihitung untuk Pekerjaan.

Nama	Jenis	Deskripsi
taskCounts	TaskCounts	Jumlah Tugas per status.
taskSlotCounts	TaskSlotCounts	Jumlah TaskSlots yang diperlukan oleh Tugas per status.

TaskSlotCounts

TaskSlot dihitung untuk Pekerjaan.

Nama	Jenis	Deskripsi
active	integer	Jumlah TaskSlots untuk Tugas aktif.
completed	integer	Jumlah TaskSlots untuk Tugas yang telah selesai.
failed	integer	Jumlah TaskSlots untuk Tugas yang gagal.
running	integer	Jumlah TaskSlots untuk menjalankan Tugas.
succeeded	integer	Jumlah TaskSlots untuk Tugas yang berhasil.