Job - Get Task Counts

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=2022-01-01.15.0
GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2022-01-01.15.0

Parameter URI

Name In Required Type Description
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"

Name Required Type Description
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

Name Type Description
200 OK

Respons yang berisi jumlah Tugas untuk Pekerjaan yang ditentukan.

Headers

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

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

Job get task counts

Sample Request

GET account.region.batch.azure.com/jobs/jobId/taskcounts?api-version=2022-01-01.15.0


Sample Response

{
  "taskCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  },
  "taskSlotCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  }
}

Definisi

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

ErrorMessage

Pesan kesalahan yang 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.

Name Type Description
code
  • string

Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.

message

Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

values

Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Name Type Description
key
  • string

Pengidentifikasi yang menentukan arti properti Nilai.

value
  • string

Informasi tambahan disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.

Name Type Description
lang
  • string

Kode bahasa pesan kesalahan

value
  • string

Teks pesan.

TaskCounts

Tugas dihitung untuk Pekerjaan.

Name Type Description
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.

Name Type Description
taskCounts

Jumlah Tugas per status.

taskSlotCounts

Jumlah TaskSlots yang diperlukan oleh Tugas per status.

TaskSlotCounts

TaskSlot dihitung untuk Pekerjaan.

Name Type Description
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.