Tasks - List Sub Tasks

Layanan:: Batch Service

Versi API:: 2025-06-01

Mencantumkan semua subtugas yang terkait dengan Tugas multi-instans yang ditentukan.
Jika Tugas bukan Tugas multi-instans maka ini mengembalikan koleksi kosong.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01

Dengan parameter opsional:

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01&timeOut={timeOut}&$select={$select}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir akun batch (misalnya: https://batchaccount.eastus2.batch.azure.com).
jobId	path	True	string	ID pekerjaan.
taskId	path	True	string	ID tugas.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
$select	query		string[]	Klausa $select OData.
timeOut	query		integer (int32)	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, defaultnya akan digunakan sebagai gantinya.".

Header Permintaan

Nama	Jenis	Deskripsi
client-request-id	string	Identitas permintaan yang dihasilkan penelepon, 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-rfc7231)	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	BatchTaskListSubtasksResult	Permintaan telah berhasil. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

BatchTaskListSubtasksResult

Permintaan telah berhasil.

Header

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://batch.core.windows.net//.default

Contoh

Task list subtasks

Permintaan sampel

HTTP

GET {endpoint}/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2025-06-01

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": 1,
      "startTime": "2025-09-06T06:59:16.3139271Z",
      "endTime": "2025-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2025-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2025-09-06T06:59:16.3139271Z",
      "exitCode": 0,
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_3-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_3-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1"
      }
    },
    {
      "id": 2,
      "startTime": "2025-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2025-09-06T06:59:16.9702844Z",
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_2-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_2-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
BatchErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
BatchErrorSourceCategory	Enum BatchErrorSourceCategory
BatchNodeInfo	Informasi tentang Simpul Komputasi tempat Tugas dijalankan.
BatchSubtask	Informasi tentang subtugas Azure Batch.
BatchSubtaskState	Enum BatchSubtaskState
BatchTaskContainerExecutionInfo	Berisi informasi tentang kontainer yang dijalankan Tugas.
BatchTaskExecutionResult	Enum BatchTaskExecutionResult
BatchTaskFailureInfo	Informasi tentang kegagalan Tugas.
BatchTaskListSubtasksResult	Hasil daftar subtugas Tugas.
NameValuePair	Mewakili pasangan nama-nilai.

BatchError

Objek

Respons kesalahan diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	BatchErrorMessage	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

Objek

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 yang disertakan dengan respons kesalahan.

BatchErrorMessage

Objek

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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

BatchErrorSourceCategory

Enumerasi

Enum BatchErrorSourceCategory

Nilai	Deskripsi
usererror	Kesalahan ini disebabkan oleh masalah pengguna, seperti kesalahan konfigurasi.
servererror	Kesalahan ini disebabkan oleh masalah server internal.

BatchNodeInfo

Objek

Informasi tentang Simpul Komputasi tempat Tugas dijalankan.

Nama	Jenis	Deskripsi
affinityId	string	Pengidentifikasi untuk Node tempat Tugas berjalan, yang dapat diteruskan saat menambahkan Tugas untuk meminta Tugas dijadwalkan pada Node Komputasi ini.
nodeId	string	ID Node Komputasi tempat Tugas berjalan.
nodeUrl	string (uri)	URL Node Komputasi tempat Tugas berjalan.
poolId	string	ID Kumpulan tempat Tugas berjalan.
taskRootDirectory	string	Direktori root Tugas pada Node Komputasi.
taskRootDirectoryUrl	string (uri)	URL ke direktori akar Tugas pada Node Komputasi.

BatchSubtask

Objek

Informasi tentang subtugas Azure Batch.

Nama	Jenis	Deskripsi
containerInfo	BatchTaskContainerExecutionInfo	Informasi tentang kontainer tempat Tugas dijalankan. Properti ini diatur hanya jika Tugas berjalan dalam konteks kontainer.
endTime	string (date-time)	Waktu di mana subtugas selesai. Properti ini diatur hanya jika subtugas dalam status Selesai.
exitCode	integer (int32)	Kode keluar program yang ditentukan pada baris perintah subtugas. Properti ini diatur hanya jika subtugas dalam status selesai. Secara umum, kode keluar untuk suatu proses mencerminkan konvensi khusus yang diterapkan oleh pengembang aplikasi untuk proses tersebut. Jika Anda menggunakan nilai kode keluar untuk membuat keputusan dalam kode Anda, pastikan Anda mengetahui konvensi kode keluar yang digunakan oleh proses aplikasi. Namun, jika layanan Batch menghentikan subtugas (karena batas waktu, atau penghentian pengguna melalui API), Anda mungkin melihat kode keluar yang ditentukan sistem operasi.
failureInfo	BatchTaskFailureInfo	Informasi yang menjelaskan kegagalan Tugas, jika ada. Properti ini diatur hanya jika Tugas dalam status selesai dan mengalami kegagalan.
id	integer (int32)	ID subtugas.
nodeInfo	BatchNodeInfo	Informasi tentang Node Komputasi tempat subtugas berjalan.
previousState	BatchSubtaskState	Status subtugas sebelumnya. Properti ini tidak diatur jika subtugas dalam status awal yang berjalan.
previousStateTransitionTime	string (date-time)	Waktu di mana subtugas memasuki keadaan sebelumnya. Properti ini tidak diatur jika subtugas dalam status awal yang berjalan.
result	BatchTaskExecutionResult	Hasil eksekusi Tugas. Jika nilainya 'gagal', maka detail kegagalan dapat ditemukan di properti failureInfo.
startTime	string (date-time)	Waktu di mana subtugas mulai berjalan. Jika subtugas telah dimulai ulang atau dicoba ulang, ini adalah waktu terakhir di mana subtugas mulai berjalan.
state	BatchSubtaskState	Status subtugas saat ini.
stateTransitionTime	string (date-time)	Waktu di mana subtugas memasuki statusnya saat ini.

BatchSubtaskState

Enumerasi

Enum BatchSubtaskState

Nilai	Deskripsi
preparing	Tugas telah ditetapkan ke Node Komputasi, tetapi sedang menunggu Tugas Persiapan Pekerjaan yang diperlukan untuk diselesaikan pada Node Komputasi. Jika Tugas Persiapan Pekerjaan berhasil, Tugas akan beralih ke berjalan. Jika Tugas Persiapan Pekerjaan gagal, Tugas akan kembali aktif dan akan memenuhi syarat untuk ditetapkan ke Node Komputasi yang berbeda.
running	Tugas berjalan pada Compute Node. Ini termasuk persiapan tingkat tugas seperti mengunduh file sumber daya atau menyebarkan Paket yang ditentukan pada Tugas - ini tidak selalu berarti bahwa baris perintah Tugas telah mulai dieksekusi.
completed	Tugas tidak lagi memenuhi syarat untuk dijalankan, biasanya karena Tugas telah berhasil diselesaikan, atau Tugas telah selesai tidak berhasil dan telah menghabiskan batas percobaan ulangnya. Tugas juga ditandai sebagai selesai jika terjadi kesalahan saat meluncurkan Tugas, atau ketika Tugas telah dihentikan.

BatchTaskContainerExecutionInfo

Objek

Berisi informasi tentang kontainer yang dijalankan Tugas.

Nama	Jenis	Deskripsi
containerId	string	ID kontainer.
error	string	Informasi kesalahan terperinci tentang kontainer. Ini adalah string kesalahan terperinci dari layanan Docker, jika tersedia. Ini setara dengan bidang kesalahan yang dikembalikan oleh "docker inspect".
state	string	Keadaan kontainer. Ini adalah status kontainer menurut layanan Docker. Ini setara dengan bidang status yang dikembalikan oleh "docker inspect".

BatchTaskExecutionResult

Enumerasi

Enum BatchTaskExecutionResult

Nilai	Deskripsi
success	Tugas berhasil berjalan.
failure	Ada kesalahan selama pemrosesan Tugas. Kegagalan mungkin terjadi sebelum proses Tugas diluncurkan, saat proses Tugas sedang dijalankan, atau setelah proses Tugas keluar.

BatchTaskFailureInfo

Objek

Informasi tentang kegagalan Tugas.

Nama	Jenis	Deskripsi
category	BatchErrorSourceCategory	Kategori kesalahan Tugas.
code	string	Pengidentifikasi untuk kesalahan Tugas. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	NameValuePair[]	Daftar detail tambahan yang terkait dengan kesalahan.
message	string	Pesan yang menjelaskan kesalahan Tugas, yang dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

BatchTaskListSubtasksResult

Objek

Hasil daftar subtugas Tugas.

Nama	Jenis	Deskripsi
odata.nextLink	string (uri)	URL untuk mendapatkan kumpulan hasil berikutnya.
value	BatchSubtask[]	Daftar subtugas.

NameValuePair

Objek

Mewakili pasangan nama-nilai.

Nama	Jenis	Deskripsi
name	string	Nama dalam pasangan nama-nilai.
value	string	Nilai dalam pasangan nama-nilai.