Job - List Preparation And Release Task Status

Referensi

Service:: Batch Service

API Version:: 2023-11-01.18.0

Mencantumkan status eksekusi Tugas Persiapan Pekerjaan dan Rilis Pekerjaan untuk Pekerjaan yang ditentukan di seluruh Simpul Komputasi tempat Pekerjaan telah berjalan.
API ini mengembalikan status Tugas Persiapan Pekerjaan dan Pelepasan Pekerjaan pada semua Simpul Komputasi yang telah menjalankan Tugas Persiapan Pekerjaan atau Rilis Pekerjaan. Ini termasuk Simpul Komputasi yang sejak saat itu telah dihapus dari Kumpulan. Jika API ini dipanggil pada Pekerjaan yang tidak memiliki Persiapan Pekerjaan atau Tugas Rilis Pekerjaan, layanan Batch mengembalikan kode status HTTP 409 (Konflik) dengan kode kesalahan JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&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.
$filter	query		string	Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Klausa $select OData.
maxresults	query		integer int32	Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 Tugas dapat dikembalikan.
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	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	CloudJobListPreparationAndReleaseTaskStatusResult	Respons yang berisi daftar status Tugas Persiapan Pekerjaan dan Pelepasan Pekerjaan. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Kesalahan dari layanan Batch. Jika API ini dipanggil pada Pekerjaan yang tidak memiliki Persiapan Pekerjaan atau Tugas Rilis Pekerjaan, layanan Batch mengembalikan kode status HTTP 409.

Nama

Jenis

Deskripsi

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Respons yang berisi daftar status Tugas Persiapan Pekerjaan dan Pelepasan Pekerjaan.

Headers

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

Other Status Codes

BatchError

Kesalahan dari layanan Batch. Jika API ini dipanggil pada Pekerjaan yang tidak memiliki Persiapan Pekerjaan atau Tugas Rilis Pekerjaan, layanan Batch mengembalikan kode status HTTP 409.

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 list preparation and release task status

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
CloudJobListPreparationAndReleaseTaskStatusResult	Hasil pencantuman status Tugas Persiapan Pekerjaan dan Pelepasan Kerja untuk Pekerjaan.
ErrorCategory	Kategori kesalahan.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
JobPreparationAndReleaseTaskExecutionInformation	Status Tugas Persiapan Pekerjaan dan Rilis Pekerjaan pada Simpul Komputasi.
JobPreparationTaskExecutionInformation	Berisi informasi tentang eksekusi Tugas Persiapan Pekerjaan pada Simpul Komputasi.
JobPreparationTaskState	Status Tugas Persiapan Pekerjaan saat ini pada Simpul Komputasi.
JobReleaseTaskExecutionInformation	Berisi informasi tentang eksekusi Tugas Rilis Pekerjaan pada Simpul Komputasi.
JobReleaseTaskState	Status Tugas Rilis Pekerjaan saat ini pada Simpul Komputasi.
NameValuePair	Mewakili pasangan nama-nilai.
TaskContainerExecutionInformation	Berisi informasi tentang kontainer yang dijalankan Tugas.
TaskExecutionResult	Hasil eksekusi Tugas.
TaskFailureInformation	Informasi tentang kegagalan Tugas.

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.

CloudJobListPreparationAndReleaseTaskStatusResult

Hasil pencantuman status Tugas Persiapan Pekerjaan dan Pelepasan Kerja untuk Pekerjaan.

Nama	Jenis	Deskripsi
odata.nextLink	string	URL untuk mendapatkan serangkaian hasil berikutnya.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Daftar informasi eksekusi Tugas Persiapan Pekerjaan dan Pelepasan Kerja.

ErrorCategory

Kategori kesalahan.

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

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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

JobPreparationAndReleaseTaskExecutionInformation

Status Tugas Persiapan Pekerjaan dan Rilis Pekerjaan pada Simpul Komputasi.

Nama	Jenis	Deskripsi
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informasi tentang status eksekusi Tugas Persiapan Pekerjaan pada Simpul Komputasi ini.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informasi tentang status eksekusi Tugas Rilis Pekerjaan pada Simpul Komputasi ini. Properti ini diatur hanya jika Tugas Rilis Pekerjaan telah berjalan pada Simpul Komputasi.
nodeId	string	ID Simpul Komputasi yang dirujuk entri ini.
nodeUrl	string	URL Simpul Komputasi yang dirujuk entri ini.
poolId	string	ID Kumpulan yang berisi Simpul Komputasi yang dirujuk entri ini.

JobPreparationTaskExecutionInformation

Berisi informasi tentang eksekusi Tugas Persiapan Pekerjaan pada Simpul Komputasi.

Nama	Jenis	Deskripsi
containerInfo	TaskContainerExecutionInformation	Informasi tentang kontainer tempat Tugas dijalankan. Properti ini diatur hanya jika Tugas berjalan dalam konteks kontainer.
endTime	string	Waktu di mana Tugas Persiapan Pekerjaan selesai. Properti ini diatur hanya jika Tugas dalam status Selesai.
exitCode	integer	Kode keluar program yang ditentukan pada baris perintah Tugas. Parameter ini dikembalikan hanya jika Tugas dalam status selesai. Kode keluar untuk proses mencerminkan konvensi tertentu 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. Perhatikan bahwa kode keluar juga dapat dihasilkan oleh sistem operasi Simpul Komputasi, seperti ketika proses dihentikan secara paksa.
failureInfo	TaskFailureInformation	Informasi yang menjelaskan kegagalan Tugas, jika ada. Properti ini diatur hanya jika Tugas dalam status selesai dan mengalami kegagalan.
lastRetryTime	string	Waktu terbaru saat mencoba kembali Tugas Persiapan Pekerjaan mulai berjalan. Properti ini diatur hanya jika Tugas dicoba ulang (yaitu retryCount bukan nol). Jika ada, ini biasanya sama dengan startTime, tetapi mungkin berbeda jika Tugas telah dimulai ulang karena alasan selain mencoba kembali; misalnya, jika Compute Node di-boot ulang selama coba lagi, maka startTime diperbarui tetapi lastRetryTime tidak.
result	TaskExecutionResult	Hasil dari eksekusi Tugas. Jika nilainya 'gagal', maka detail kegagalan dapat ditemukan di properti failureInfo.
retryCount	integer	Berapa kali Tugas telah dicoba ulang oleh layanan Batch. Kegagalan aplikasi tugas (kode keluar bukan nol) dicoba ulang, kesalahan pra-pemrosesan (Tugas tidak dapat dijalankan) dan kesalahan pengunggahan file tidak dicoba kembali. Layanan Batch akan mencoba kembali Tugas hingga batas yang ditentukan oleh batasan. Kegagalan aplikasi tugas (kode keluar bukan nol) dicoba ulang, kesalahan pra-pemrosesan (Tugas tidak dapat dijalankan) dan kesalahan pengunggahan file tidak dicoba kembali. Layanan Batch akan mencoba kembali Tugas hingga batas yang ditentukan oleh batasan.
startTime	string	Waktu di mana Tugas mulai berjalan. Jika Tugas telah dimulai ulang atau dicoba ulang, ini adalah waktu terbaru di mana Tugas mulai berjalan.
state	JobPreparationTaskState	Status Tugas Persiapan Pekerjaan saat ini pada Simpul Komputasi.
taskRootDirectory	string	Direktori akar Tugas Persiapan Pekerjaan pada Simpul Komputasi. Anda dapat menggunakan jalur ini untuk mengambil file yang dibuat oleh Tugas, seperti file log.
taskRootDirectoryUrl	string	URL ke direktori akar Tugas Persiapan Pekerjaan pada Simpul Komputasi.

JobPreparationTaskState

Status Tugas Persiapan Pekerjaan saat ini pada Simpul Komputasi.

Nama	Jenis	Deskripsi
completed	string	Tugas telah keluar dengan kode keluar 0, atau Tugas telah kelelahan batas coba lagi, atau layanan Batch tidak dapat memulai Tugas karena kesalahan persiapan Tugas (seperti kegagalan pengunduhan file sumber daya).
running	string	Tugas saat ini sedang berjalan (termasuk mencoba kembali).

JobReleaseTaskExecutionInformation

Berisi informasi tentang eksekusi Tugas Rilis Pekerjaan pada Simpul Komputasi.

Nama	Jenis	Deskripsi
containerInfo	TaskContainerExecutionInformation	Informasi tentang kontainer tempat Tugas dijalankan. Properti ini diatur hanya jika Tugas berjalan dalam konteks kontainer.
endTime	string	Waktu di mana Tugas Rilis Pekerjaan selesai. Properti ini diatur hanya jika Tugas dalam status Selesai.
exitCode	integer	Kode keluar program yang ditentukan pada baris perintah Tugas. Parameter ini dikembalikan hanya jika Tugas dalam status selesai. Kode keluar untuk proses mencerminkan konvensi tertentu 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. Perhatikan bahwa kode keluar juga dapat dihasilkan oleh sistem operasi Simpul Komputasi, seperti ketika proses dihentikan secara paksa.
failureInfo	TaskFailureInformation	Informasi yang menjelaskan kegagalan Tugas, jika ada. Properti ini diatur hanya jika Tugas dalam status selesai dan mengalami kegagalan.
result	TaskExecutionResult	Hasil dari eksekusi Tugas. Jika nilainya 'gagal', maka detail kegagalan dapat ditemukan di properti failureInfo.
startTime	string	Waktu di mana Tugas mulai berjalan. Jika Tugas telah dimulai ulang atau dicoba ulang, ini adalah waktu terbaru di mana Tugas mulai berjalan.
state	JobReleaseTaskState	Status Tugas Rilis Pekerjaan saat ini pada Simpul Komputasi.
taskRootDirectory	string	Direktori akar Tugas Rilis Pekerjaan pada Simpul Komputasi. Anda dapat menggunakan jalur ini untuk mengambil file yang dibuat oleh Tugas, seperti file log.
taskRootDirectoryUrl	string	URL ke direktori akar Tugas Rilis Pekerjaan pada Simpul Komputasi.

JobReleaseTaskState

Status Tugas Rilis Pekerjaan saat ini pada Simpul Komputasi.

Nama	Jenis	Deskripsi
completed	string	Tugas telah keluar dengan kode keluar 0, atau Tugas telah kelelahan batas coba lagi, atau layanan Batch tidak dapat memulai Tugas karena kesalahan persiapan Tugas (seperti kegagalan pengunduhan file sumber daya).
running	string	Tugas saat ini sedang berjalan (termasuk mencoba kembali).

NameValuePair

Mewakili pasangan nama-nilai.

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

TaskContainerExecutionInformation

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 "inspeksi docker".
state	string	Status kontainer. Ini adalah status kontainer sesuai dengan layanan Docker. Ini setara dengan bidang status yang dikembalikan oleh "inspeksi docker".

TaskExecutionResult

Hasil eksekusi Tugas.

Nama	Jenis	Deskripsi
failure	string	Terjadi kesalahan selama pemrosesan Tugas. Kegagalan mungkin terjadi sebelum proses Tugas diluncurkan, saat proses Tugas sedang dijalankan, atau setelah proses Tugas keluar.
success	string	Tugas berhasil dijalankan.

TaskFailureInformation

Informasi tentang kegagalan Tugas.

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

Bagikan melalui

Job - List Preparation And Release Task Status

Parameter URI

Header Permintaan

Respons

Keamanan

azure_auth

Scopes

Authorization

Contoh

Job list preparation and release task status

Sample Request

Sample Response

Definisi

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Sumber Daya Tambahan: