Path - List

  • Referensi
Service:
Storage Services
API Version:
2023-08-03

Mencantumkan jalur dan propertinya dalam sistem file tertentu.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
With optional parameters: 
GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
accountName
 path True

string

Nama akun Azure Storage.
dnsSuffix
 path True

string

Akhiran DNS untuk titik akhir Azure Data Lake Storage.
filesystem
 path True

string

Pengidentifikasi sistem file. Nilai harus dimulai dan diakhir dengan huruf atau angka dan hanya boleh berisi huruf, angka, dan karakter tanda hubung (-). Tanda hubung berturut-turut tidak diizinkan. Semua huruf harus huruf kecil. Nilai harus memiliki antara 3 dan 63 karakter.

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Jika "true", semua jalur dicantumkan; jika tidak, hanya jalur di akar sistem file yang dicantumkan. Jika "direktori" ditentukan, daftar hanya akan menyertakan jalur yang memiliki akar yang sama.
resource
 query True

FilesystemResourceType

Nilainya harus "filesystem" untuk semua operasi sistem file.
continuation
 query

string

Jumlah jalur yang dikembalikan dengan setiap pemanggilan dibatasi. Jika jumlah jalur yang akan dikembalikan melebihi batas ini, token kelanjutan dikembalikan dalam header respons x-ms-continuation. Ketika token kelanjutan dikembalikan dalam respons, token tersebut harus ditentukan dalam pemanggilan operasi daftar berikutnya untuk terus mencantumkan jalur.
directory
 query

string

Memfilter hasil ke jalur dalam direktori yang ditentukan. Kesalahan terjadi jika direktori tidak ada.
maxResults
 query

integer

int32

Nilai opsional yang menentukan jumlah maksimum item yang akan dikembalikan. Jika dihilangkan atau lebih besar dari 5.000, respons akan mencakup hingga 5.000 item.
timeout
 query

integer

int32

Nilai batas waktu operasi opsional dalam hitung detik. Periode dimulai ketika permintaan diterima oleh layanan. Jika nilai batas waktu berlalu sebelum operasi selesai, operasi gagal.
upn
 query

boolean

Pilihan. Hanya berlaku saat Namespace Hierarki diaktifkan untuk akun tersebut. Jika "true", nilai identitas pengguna yang dikembalikan di bidang pemilik dan grup dari setiap entri daftar akan diubah dari ID Objek Azure Active Directory menjadi Nama Utama Pengguna. Jika "false", nilai akan dikembalikan sebagai ID Objek Azure Active Directory. Nilai defaultnya adalah false. Perhatikan bahwa ID Objek grup dan aplikasi tidak diterjemahkan karena tidak memiliki nama ramah yang unik.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-request-id

string

UUID yang dicatat dalam log analitik untuk pemecahan masalah dan korelasi.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Ini diperlukan saat menggunakan otorisasi kunci bersama.
x-ms-version

string

Menentukan versi protokol REST yang digunakan untuk memproses permintaan. Ini diperlukan saat menggunakan otorisasi kunci bersama.

Respons

Nama Jenis Deskripsi
200 OK

PathList

Ok

Headers

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-continuation: string
  • x-ms-encryption-scope: string
Other Status Codes

DataLakeStorageError

Terjadi kesalahan. Kemungkinan status HTTP, kode, dan string pesan tercantum di bawah ini:

  • 400 Permintaan Buruk, ContentLengthMustBeZero, "Header permintaan Panjang Konten harus nol."
  • 400 Permintaan Buruk, InvalidAuthenticationInfo, "Informasi autentikasi tidak diberikan dalam format yang benar. Periksa nilai header Otorisasi."
  • 400 Permintaan Buruk, InvalidFlushPosition, "Data yang diunggah tidak berdekatan atau nilai parameter kueri posisi tidak sama dengan panjang file setelah menambahkan data yang diunggah."
  • 400 Permintaan Buruk, InvalidHeaderValue, "Nilai untuk salah satu header HTTP tidak dalam format yang benar."
  • 400 Permintaan Buruk, InvalidHttpVerb, "Kata kerja HTTP yang ditentukan tidak valid - tidak dikenali oleh server."
  • 400 Permintaan Buruk, InvalidInput, "Salah satu input permintaan tidak valid."
  • 400 Permintaan Buruk, InvalidPropertyName, "Nama properti tidak boleh kosong."
  • 400 Permintaan Buruk, InvalidPropertyName, "Nama properti berisi karakter yang tidak valid."
  • 400 Permintaan Buruk, InvalidQueryParameterValue, "Nilai untuk salah satu parameter kueri yang ditentukan dalam URI permintaan tidak valid."
  • 400 Permintaan Buruk, InvalidResourceName, "Nama sumber daya yang ditentukan berisi karakter yang tidak valid."
  • 400 Permintaan Buruk, InvalidSourceUri, "URI sumber tidak valid."
  • 400 Permintaan Buruk, InvalidUri, "URI permintaan tidak valid."
  • 400 Permintaan Buruk, MissingRequiredHeader, "Header HTTP yang wajib untuk permintaan ini tidak ditentukan."
  • 400 Permintaan Buruk, MissingRequiredQueryParameter, "Parameter kueri yang wajib untuk permintaan ini tidak ditentukan."
  • 400 Permintaan Buruk, MultipleConditionHeadersNotSupported, "Beberapa header kondisi tidak didukung."
  • 400 Permintaan Buruk, OutOfRangeInput, "Salah satu input permintaan di luar rentang."
  • 400 Permintaan Buruk, OutOfRangeQueryParameterValue, "Salah satu parameter kueri yang ditentukan dalam URI permintaan berada di luar rentang yang diizinkan."
  • 400 Permintaan Buruk, UnsupportedHeader, "Salah satu header yang ditentukan dalam permintaan tidak didukung."
  • 400 Permintaan Buruk, UnsupportedQueryParameter, "Salah satu parameter kueri yang ditentukan dalam URI permintaan tidak didukung."
  • 400 Permintaan Buruk, UnsupportedRestVersion, "Versi Rest yang ditentukan Tidak Didukung."
  • 403 Terlarang, AccountIsDisabled, "Akun yang ditentukan dinonaktifkan."
  • 403 Terlarang, AuthorizationFailure, "Permintaan ini tidak berwenang untuk melakukan operasi ini."
  • 403 Terlarang, InsufficientAccountPermissions, "Akun yang diakses tidak memiliki izin yang memadai untuk menjalankan operasi ini."
  • 404 Tidak Ditemukan, FilesystemNotFound, "Sistem file yang ditentukan tidak ada."
  • 404 Tidak Ditemukan, PathNotFound, "Jalur yang ditentukan tidak ada."
  • 404 Tidak Ditemukan, RenameDestinationParentPathNotFound, "Direktori induk jalur tujuan tidak ada."
  • 404 Tidak Ditemukan, ResourceNotFound, "Sumber daya yang ditentukan tidak ada."
  • 404 Tidak Ditemukan, SourcePathNotFound, "Jalur sumber untuk operasi penggantian nama tidak ada."
  • Metode 405 Tidak Diizinkan, Tidak DidukungHttpVerb, "Sumber daya tidak mendukung kata kerja HTTP yang ditentukan."
  • 409 Konflik, DestinationPathIsBeingDeleted, "Jalur tujuan yang ditentukan ditandai untuk dihapus."
  • 409 Konflik, DirectoryNotEmpty, "Nilai parameter kueri rekursif harus benar untuk menghapus direktori yang tidak kosong."
  • Konflik 409, FilesystemAlreadyExists, "Sistem file yang ditentukan sudah ada."
  • Konflik 409, FilesystemBeingDeleted, "Sistem file yang ditentukan sedang dihapus."
  • 409 Konflik, InvalidDestinationPath, "Jalur yang ditentukan, atau elemen jalur, ada dan jenis sumber dayanya tidak valid untuk operasi ini." * 409 Konflik, InvalidFlushOperation, "Sumber daya dibuat atau dimodifikasi oleh API Blob Service dan tidak dapat ditulis oleh Data Lake Storage Service API."
  • 409 Conflict, InvalidRenameSourcePath, "Direktori sumber tidak boleh sama dengan direktori tujuan, juga tidak dapat menjadi subdirektori direktori sumber."
  • 409 Konflik, InvalidSourceOrDestinationResourceType, "Jenis sumber daya sumber dan tujuan harus identik."
  • 409 Konflik, LeaseAlreadyPresent, "Sudah ada sewa yang ada."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "ID sewa yang ditentukan tidak cocok dengan ID sewa untuk sumber daya dengan operasi sewa yang ditentukan."
  • 409 Konflik, LeaseIsAlreadyBroken, "Sewa telah rusak dan tidak dapat rusak lagi."
  • 409 Konflik, LeaseIsBreakingAndCannotBeAcquired, "ID sewa cocok, tetapi sewa saat ini dalam status melanggar dan tidak dapat diperoleh sampai rusak."
  • 409 Konflik, LeaseIsBreakingAndCannotBeChanged, "ID sewa cocok, tetapi sewa saat ini dalam status melanggar dan tidak dapat diubah."
  • 409 Konflik, LeaseIsBrokenAndCannotBeRenewed, "ID sewa cocok, tetapi sewa telah rusak secara eksplisit dan tidak dapat diperpanjang."
  • 409 Conflict, LeaseNameMismatch, "Nama sewa yang ditentukan tidak cocok dengan nama sewa yang ada."
  • 409 Konflik, LeaseNotPresentWithLeaseOperation, "ID sewa tidak ada dengan operasi sewa yang ditentukan."
  • Konflik 409, PathAlreadyExists, "Jalur yang ditentukan sudah ada."
  • 409 Konflik, PathConflict, "Jalur yang ditentukan, atau elemen jalur, ada dan jenis sumber dayanya tidak valid untuk operasi ini."
  • 409 Konflik, SourcePathIsBeingDeleted, "Jalur sumber yang ditentukan ditandai untuk dihapus."
  • 409 Conflict, ResourceTypeMismatch, "Jenis sumber daya yang ditentukan dalam permintaan tidak cocok dengan jenis sumber daya."
  • 412 Prasyarat Gagal, ConditionNotMet, "Kondisi yang ditentukan menggunakan header bersyarat HTTP tidak terpenuhi."
  • 412 Prasyarat Gagal, LeaseIdMismatch, "ID sewa yang ditentukan tidak cocok dengan ID sewa untuk sumber daya."
  • 412 Prasyarat Gagal, LeaseIdMissing, "Saat ini ada sewa pada sumber daya dan tidak ada ID sewa yang ditentukan dalam permintaan."
  • 412 Prasyarat Gagal, LeaseNotPresent, "Saat ini tidak ada sewa pada sumber daya."
  • 412 Prasyarat Gagal, LeaseLost, "ID sewa ditentukan, tetapi sewa untuk sumber daya telah kedaluwarsa."
  • 412 Prasyarat Gagal, SourceConditionNotMet, "Kondisi sumber yang ditentukan menggunakan header bersyarat HTTP tidak terpenuhi."
  • 413 Entitas Permintaan Terlalu Besar, RequestBodyTooLarge, "Isi permintaan terlalu besar dan melebihi batas maksimum yang diizinkan."
  • 416 Rentang yang Diminta Tidak Dapat Dipenuhi, InvalidRange, "Rentang yang ditentukan tidak valid untuk ukuran sumber daya saat ini."
  • 500 Kesalahan Server Internal, InternalError, "Server mengalami kesalahan internal. Silakan coba lagi permintaannya."
  • 500 Kesalahan Server Internal, OperationTimedOut, "Operasi tidak dapat diselesaikan dalam waktu yang diizinkan."
  • 503 Layanan Tidak Tersedia, ServerBusy, "Keluar melebihi batas akun."
  • 503 Layanan Tidak Tersedia, ServerBusy, "Ingress melebihi batas akun."
  • 503 Layanan Tidak Tersedia, ServerBusy, "Operasi per detik melebihi batas akun."
  • 503 Layanan Tidak Tersedia, ServerBusy, "Server saat ini tidak dapat menerima permintaan. Silakan coba ulang permintaan Anda."

Headers

  • x-ms-request-id: string
  • x-ms-version: string

Definisi

Nama Deskripsi
DataLakeStorageError
Error

Objek respons kesalahan layanan.
FilesystemResourceType

Nilainya harus "filesystem" untuk semua operasi sistem file.
Path
PathList

DataLakeStorageError

Nama Jenis Deskripsi
error

Error

Objek respons kesalahan layanan.

Error

Objek respons kesalahan layanan.

Nama Jenis Deskripsi
code

string

Kode kesalahan layanan.
message

string

Pesan kesalahan layanan.

FilesystemResourceType

Nilainya harus "filesystem" untuk semua operasi sistem file.

Nama Jenis Deskripsi
filesystem

string

Path

Nama Jenis Nilai Default Deskripsi
contentLength

integer

eTag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Jika nilai properti konteks enkripsi diatur, nilai akan mengembalikan nilai yang ditetapkan. Hanya berlaku saat Namespace Hierarki diaktifkan untuk akun tersebut.
x-ms-encryption-key-sha256

string

Server akan menggemakan SHA256 dari kunci enkripsi yang disediakan pelanggan untuk memvalidasi kunci yang digunakan dalam operasi.
x-ms-encryption-scope

string

Jika permintaan menggunakan cakupan enkripsi, sehingga klien dapat memastikan konten permintaan berhasil dienkripsi menggunakan cakupan enkripsi.
x-ms-server-encrypted: true/false

boolean

Nilai header ini diatur ke true jika konten permintaan berhasil dienkripsi menggunakan algoritma yang ditentukan.

PathList

Nama Jenis Deskripsi
paths

Path[]