File - List From Task

Service:

Batch Service

API Version:

2023-11-01.18.0

Mencantumkan file dalam direktori Tugas pada Simpul Komputasinya.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&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 yang berisi Tugas.
taskId	path	True	string	ID Tugas yang filenya ingin Anda cantumkan.
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-task-files.
maxresults	query		integer int32	Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 file dapat dikembalikan.
recursive	query		boolean	Apakah akan mencantumkan turunan dari direktori Tugas. Parameter ini dapat digunakan dalam kombinasi dengan parameter filter untuk mencantumkan jenis file tertentu.
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	NodeFileListResult	Respons yang berisi daftar file. Headers client-request-id: string request-id: string ETag: string Last-Modified: 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

File list from task

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.679195Z",
        "lastModified": "2014-09-19T21:56:17.679195Z",
        "contentLength": 1813,
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.5590855Z",
        "lastModified": "2014-09-19T21:56:17.5590855Z",
        "contentLength": 0,
        "contentType": "application/octet-stream"
      }
    }
  ]
}

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.
FileProperties	Properti file pada Simpul Komputasi.
NodeFile	Informasi tentang file atau direktori pada Simpul Komputasi.
NodeFileListResult	Hasil dari mencantumkan file pada Simpul Komputasi, atau file yang terkait dengan Tugas pada Simpul Komputasi.

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.

FileProperties

Properti file pada Simpul Komputasi.

Nama	Jenis	Deskripsi
contentLength	integer	Panjang file.
contentType	string	Tipe konten file.
creationTime	string	Waktu pembuatan file. Waktu pembuatan tidak dikembalikan untuk file pada Simpul Komputasi Linux.
fileMode	string	Atribut mode file dalam format oktal. Mode file dikembalikan hanya untuk file di Simpul Komputasi Linux.
lastModified	string	Waktu di mana file terakhir diubah.

NodeFile

Informasi tentang file atau direktori pada Simpul Komputasi.

Nama	Jenis	Deskripsi
isDirectory	boolean	Apakah objek mewakili direktori.
name	string	Jalur file.
properties	FileProperties	Properti file.
url	string	URL file.

NodeFileListResult

Hasil dari mencantumkan file pada Simpul Komputasi, atau file yang terkait dengan Tugas pada Simpul Komputasi.

Nama	Jenis	Deskripsi
odata.nextLink	string	URL untuk mendapatkan serangkaian hasil berikutnya.
value	NodeFile[]	Daftar file.