Path - Lease

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

Jalur Sewa
Buat dan kelola sewa untuk membatasi akses tulis dan hapus ke jalur. Operasi ini mendukung permintaan HTTP kondisional. Untuk informasi selengkapnya, lihat Menentukan Header Kondisional untuk Operasi Blob Service.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?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.

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

string

Jalur file atau direktori.
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.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-lease-action True

PathLeaseAction

Ada lima tindakan sewa: "acquire", "break", "change", "renew", dan "release". Gunakan "acquire" dan tentukan "x-ms-proposed-lease-id" dan "x-ms-lease-duration" untuk memperoleh sewa baru. Gunakan "jeda" untuk memutuskan sewa yang ada. Ketika sewa rusak, periode jeda sewa diizinkan untuk berlalu, selama waktu itu tidak ada operasi sewa kecuali jeda dan rilis dapat dilakukan pada file. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh. Gunakan "ubah" dan tentukan ID sewa saat ini di "x-ms-lease-id" dan ID sewa baru di "x-ms-proposed-lease-id" untuk mengubah ID sewa aktif. Gunakan "perbarui" dan tentukan "x-ms-lease-id" untuk memperbarui sewa yang ada. Gunakan "rilis" dan tentukan "x-ms-lease-id" untuk merilis sewa.
x-ms-lease-duration

integer

int32

Durasi sewa diperlukan untuk memperoleh sewa, dan menentukan durasi sewa dalam hitungan detik. Durasi sewa harus antara 15 dan 60 detik atau -1 untuk sewa tak terbatas.
x-ms-lease-break-period

integer

int32

Durasi periode jeda sewa bersifat opsional untuk memutuskan sewa, dan menentukan periode jeda sewa dalam hitungan detik. Durasi jeda sewa harus antara 0 dan 60 detik.
x-ms-lease-id

string

Diperlukan ketika "x-ms-lease-action" adalah "renew", "change" atau "release". Untuk tindakan perpanjangan dan rilis, ini harus cocok dengan ID sewa saat ini.

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

string

Diperlukan ketika "x-ms-lease-action" adalah "acquire" atau "change". Sewa akan diperoleh dengan ID sewa ini jika operasi berhasil.

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

string

Pilihan. Nilai ETag. Tentukan header ini untuk melakukan operasi hanya jika ETag sumber daya cocok dengan nilai yang ditentukan. ETag harus ditentukan dalam tanda kutip.
If-None-Match

string

Pilihan. Nilai ETag atau nilai wildcard khusus ("*"). Tentukan header ini untuk melakukan operasi hanya jika ETag sumber daya tidak cocok dengan nilai yang ditentukan. ETag harus ditentukan dalam tanda kutip.
If-Modified-Since

string

Pilihan. Nilai tanggal dan waktu. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak tanggal dan waktu yang ditentukan.
If-Unmodified-Since

string

Pilihan. Nilai tanggal dan waktu. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal dan waktu yang ditentukan.
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

Tindakan "perbarui", "ubah" atau "rilis" berhasil.

Headers

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
201 Created

Sewa baru telah dibuat. Tindakan "acquire" berhasil.

Headers

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
202 Accepted

Tindakan sewa "putus" berhasil.

Headers

  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-time: 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 permintaan URI 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 berada di luar jangkauan."
  • 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 permintaan URI tidak didukung."
  • 400 Permintaan Buruk, UnsupportedRestVersion, "Versi Rest yang ditentukan Tidak Didukung."
  • 403 Forbidden, AccountIsDisabled, "Akun yang ditentukan dinonaktifkan."
  • 403 Terlarang, AuthorizationFailure, "Permintaan ini tidak diizinkan 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, Ganti NamaDestinationParentPathNotFound, "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."
  • 409 Konflik, 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 dari direktori sumber."
  • 409 Konflik, InvalidSourceOrDestinationResourceType, "Jenis sumber daya sumber dan tujuan harus identik."
  • 409 Konflik, LeaseAlreadyPresent, "Sudah ada sewa yang ada."
  • 409 Konflik, LeaseIdMismatchWithLeaseOperation, "ID sewa yang ditentukan tidak cocok dengan ID sewa untuk sumber daya dengan operasi sewa yang ditentukan."
  • 409 Konflik, LeaseIsAlreadyBroken, "Sewa sudah rusak dan tidak dapat dipecah lagi."
  • 409 Konflik, LeaseIsBreakingAndCannotBeAcquired, "ID sewa cocok, tetapi sewa saat ini dalam keadaan rusak dan tidak dapat diperoleh sampai rusak."
  • 409 Konflik, LeaseIsBreakingAndCannotBeChanged, "ID sewa cocok, tetapi sewa saat ini dalam status rusak dan tidak dapat diubah."
  • 409 Konflik, LeaseIsBrokenAndCannotBeRenewed, "ID sewa cocok, tetapi sewa telah rusak secara eksplisit dan tidak dapat diperbarui."
  • 409 Conflict, LeaseNameMismatch, "Nama sewa yang ditentukan tidak cocok dengan nama sewa yang ada."
  • Konflik 409, 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.
PathLeaseAction

Ada lima tindakan sewa: "acquire", "break", "change", "renew", dan "release". Gunakan "acquire" dan tentukan "x-ms-proposed-lease-id" dan "x-ms-lease-duration" untuk memperoleh sewa baru. Gunakan "jeda" untuk memutuskan sewa yang ada. Ketika sewa rusak, periode jeda sewa diizinkan untuk berlalu, selama waktu itu tidak ada operasi sewa kecuali jeda dan rilis dapat dilakukan pada file. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh. Gunakan "ubah" dan tentukan ID sewa saat ini di "x-ms-lease-id" dan ID sewa baru di "x-ms-proposed-lease-id" untuk mengubah ID sewa aktif. Gunakan "perbarui" dan tentukan "x-ms-lease-id" untuk memperbarui sewa yang ada. Gunakan "rilis" dan tentukan "x-ms-lease-id" untuk merilis sewa.

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.

PathLeaseAction

Ada lima tindakan sewa: "acquire", "break", "change", "renew", dan "release". Gunakan "acquire" dan tentukan "x-ms-proposed-lease-id" dan "x-ms-lease-duration" untuk memperoleh sewa baru. Gunakan "jeda" untuk memutuskan sewa yang ada. Ketika sewa rusak, periode jeda sewa diizinkan untuk berlalu, selama waktu itu tidak ada operasi sewa kecuali jeda dan rilis dapat dilakukan pada file. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh. Gunakan "ubah" dan tentukan ID sewa saat ini di "x-ms-lease-id" dan ID sewa baru di "x-ms-proposed-lease-id" untuk mengubah ID sewa aktif. Gunakan "perbarui" dan tentukan "x-ms-lease-id" untuk memperbarui sewa yang ada. Gunakan "rilis" dan tentukan "x-ms-lease-id" untuk merilis sewa.

Nama Jenis Deskripsi
acquire

string

break

string

change

string

release

string

renew

string