Udostępnij za pośrednictwem

Path - Lease

  • Odwołanie
Usługa:
Storage Services
Wersja interfejsu API:
2023-08-03

Ścieżka dzierżawy
Utwórz dzierżawę i zarządzaj nią, aby ograniczyć dostęp do zapisu i usuwania do ścieżki. Ta operacja obsługuje warunkowe żądania HTTP. Aby uzyskać więcej informacji, zobacz Określanie nagłówków warunkowych dla operacji usługi Blob Service.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
Z parametrami opcjonalnymi: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
accountName
 path True

string

Nazwa konta usługi Azure Storage.
dnsSuffix
 path True

string

Sufiks DNS dla punktu końcowego usługi Azure Data Lake Storage.
filesystem
 path True

string

minLength: 3
maxLength: 63
pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$

Identyfikator systemu plików.
path
 path True

string

Ścieżka pliku lub katalogu.
timeout
 query

integer (int32)

minimum: 1

Opcjonalna wartość limitu czasu operacji w sekundach. Okres rozpoczyna się od momentu odebrania żądania przez usługę. Jeśli wartość limitu czasu upłynie przed zakończeniem operacji, operacja zakończy się niepowodzeniem.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-lease-action True

PathLeaseAction

Istnieją pięć akcji dzierżawy: "acquire", "break", "change", "renew" i "release". Użyj polecenia "acquire" i określ wartości "x-ms-proposed-lease-id" i "x-ms-lease-duration", aby uzyskać nową dzierżawę. Użyj opcji "break", aby przerwać istniejącą dzierżawę. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w którym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w pliku. Gdy dzierżawa zostanie pomyślnie przerwana, odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy. Użyj polecenia "change" i określ bieżący identyfikator dzierżawy w polu "x-ms-lease-id" i nowy identyfikator dzierżawy w polu "x-ms-proposed-lease-id", aby zmienić identyfikator dzierżawy aktywnej. Użyj polecenia "renew" i określ wartość "x-ms-lease-id", aby odnowić istniejącą dzierżawę. Użyj polecenia "release" i określ wartość "x-ms-lease-id", aby zwolnić dzierżawę.
x-ms-lease-duration

integer (int32)

Czas trwania dzierżawy jest wymagany do uzyskania dzierżawy i określa czas trwania dzierżawy w sekundach. Czas trwania dzierżawy musi należeć do zakresu od 15 do 60 sekund lub -1 dla nieskończonej dzierżawy.
x-ms-lease-break-period

integer (int32)

Okres przerwania dzierżawy jest opcjonalny, aby przerwać dzierżawę i określa okres przerwania dzierżawy w sekundach. Czas trwania przerwania dzierżawy musi wynosić od 0 do 60 sekund.
x-ms-lease-id

string

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

Wymagane, gdy wartość "x-ms-lease-action" to "renew", "change" lub "release". W przypadku akcji odnawiania i wydawania musi być zgodny z bieżącym identyfikatorem dzierżawy.
x-ms-proposed-lease-id

string

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

Wymagane, gdy wartość "x-ms-lease-action" to "acquire" lub "change". Dzierżawa zostanie uzyskana przy użyciu tego identyfikatora dzierżawy, jeśli operacja zakończy się pomyślnie.
If-Match

string

Opcjonalny. Wartość ETag. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością. Element ETag musi być określony w cudzysłowie.
If-None-Match

string

Opcjonalny. Wartość elementu ETag lub specjalna wartość wieloznaczny ("*"). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Element ETag musi być określony w cudzysłowie.
If-Modified-Since

string

Opcjonalny. Wartość daty i godziny. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonej daty i godziny.
If-Unmodified-Since

string

Opcjonalny. Wartość daty i godziny. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty i godziny.
x-ms-client-request-id

string

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

Identyfikator UUID zarejestrowany w dziennikach analizy na potrzeby rozwiązywania problemów i korelacji.
x-ms-date

string

Określa uniwersalny czas koordynowany (UTC) dla żądania. Jest to wymagane w przypadku korzystania z autoryzacji klucza współużytkowanego.
x-ms-version

string

Określa wersję protokołu REST używanego do przetwarzania żądania. Jest to wymagane w przypadku korzystania z autoryzacji klucza współużytkowanego.

Odpowiedzi

Nazwa Typ Opis
200 OK

Akcja "renew", "change" lub "release" zakończyła się pomyślnie.

Nagłówki

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

Utworzono nową dzierżawę. Akcja "nabycia" zakończyła się pomyślnie.

Nagłówki

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

Akcja dzierżawy "break" zakończyła się pomyślnie.

Nagłówki

  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-time: string
Other Status Codes

DataLakeStorageError

Wystąpił błąd. Poniżej wymieniono możliwe stany HTTP, kod i ciągi komunikatów:

  • 400 Nieprawidłowe żądanie, ContentLengthMustBeZero, "Nagłówek żądania Content-Length musi mieć wartość zero".
  • 400 Nieprawidłowe żądanie, InvalidAuthenticationInfo, "Informacje o uwierzytelnianiu nie są podane w poprawnym formacie. Sprawdź wartość nagłówka autoryzacji".
  • 400 Nieprawidłowe żądanie, InvalidFlushPosition, "Przekazane dane nie są ciągłe lub wartość parametru zapytania pozycji nie jest równa długości pliku po dołączeniu przekazanych danych".
  • 400 Nieprawidłowe żądanie, InvalidHeaderValue, "Wartość jednego z nagłówków HTTP nie jest prawidłowa".
  • 400 Nieprawidłowe żądanie, InvalidHttpVerb, "Określony czasownik HTTP jest nieprawidłowy — nie jest rozpoznawany przez serwer".
  • 400 Nieprawidłowe żądanie, InvalidInput, "Jeden z danych wejściowych żądania jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, InvalidPropertyName, "Nazwa właściwości nie może być pusta".
  • 400 Nieprawidłowe żądanie, InvalidPropertyName, "Nazwa właściwości zawiera nieprawidłowe znaki".
  • 400 Nieprawidłowe żądanie, InvalidQueryParameterValue, "Wartość dla jednego z parametrów zapytania określonych w identyfikatorze URI żądania jest nieprawidłowa".
  • 400 Nieprawidłowe żądanie, InvalidResourceName, "Określona nazwa zasobu zawiera nieprawidłowe znaki".
  • 400 Nieprawidłowe żądanie, InvalidSourceUri, "Źródłowy identyfikator URI jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, InvalidUri, "Identyfikator URI żądania jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, MissingRequiredHeader, "Nie określono nagłówka HTTP, który jest obowiązkowy dla tego żądania".
  • 400 Nieprawidłowe żądanie, MissingRequiredQueryParameter, "Nie określono parametru zapytania, który jest obowiązkowy dla tego żądania".
  • 400 Nieprawidłowe żądanie, MultipleConditionHeadersNotSupported, "Wiele nagłówków warunku nie jest obsługiwanych".
  • 400 Nieprawidłowe żądanie, OutOfRangeInput, "Jeden z danych wejściowych żądania jest poza zakresem."
  • 400 Nieprawidłowe żądanie, OutOfRangeQueryParameterValue, "Jeden z parametrów zapytania określonych w identyfikatorze URI żądania jest poza dopuszczalnym zakresem".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneHeader, "Jeden z nagłówków określonych w żądaniu nie jest obsługiwany".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneQueryParameter, "Jeden z parametrów zapytania określonych w identyfikatorze URI żądania nie jest obsługiwany".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneRestVersion, "Określona wersja REST jest nieobsługiwana".
  • 403 Zabronione, AccountIsDisabled, "Określone konto jest wyłączone".
  • 403 Zabronione, AuthorizationFailure, "To żądanie nie jest autoryzowane do wykonania tej operacji."
  • 403 Zabronione, InsufficientAccountPermissions: "Dostęp do konta nie ma wystarczających uprawnień do wykonania tej operacji".
  • 404 Nie znaleziono, FilesystemNotFound, "Określony system plików nie istnieje".
  • 404 Nie znaleziono, PathNotFound, "Określona ścieżka nie istnieje".
  • 404 Nie znaleziono, RenameDestinationParentPathNotFound, "Katalog nadrzędny ścieżki docelowej nie istnieje".
  • 404 Nie znaleziono, ResourceNotFound, "Określony zasób nie istnieje".
  • 404 Nie znaleziono, SourcePathNotFound, "Ścieżka źródłowa operacji zmiany nazwy nie istnieje".
  • 405, Metoda Niedozwolona, NieobsługiwanaHttpVerb, "Zasób nie obsługuje określonego czasownika HTTP".
  • Konflikt 409, DestinationPathIsBeingDeleted, "Określona ścieżka docelowa jest oznaczona do usunięcia."
  • 409 Conflict, DirectoryNotEmpty, "Wartość parametru zapytania cyklicznego musi być prawdziwa, aby usunąć niepusty katalog".
  • 409 Conflict, FilesystemAlreadyExists, "Określony system plików już istnieje."
  • 409 Conflict, FilesystemBeingDeleted, "Określony system plików jest usuwany."
  • 409 Conflict, InvalidDestinationPath, "Określona ścieżka lub element ścieżki, istnieje, a jego typ zasobu jest nieprawidłowy dla tej operacji." * 409 Konflikt, InvalidFlushOperation, "Zasób został utworzony lub zmodyfikowany przez interfejs API usługi Blob Service i nie może być zapisany przez interfejs API usługi Data Lake Storage."
  • 409 Konflikt, InvalidRenameSourcePath, "Katalog źródłowy nie może być taki sam jak katalog docelowy, ani nie może być podkatalogem katalogu źródłowego."
  • Konflikt 409, InvalidSourceOrDestinationResourceType, "Typ zasobu źródłowego i docelowego musi być identyczny".
  • 409 Konflikt, LeaseAlreadyPresent, "Istnieje już dzierżawa".
  • 409 Konflikt, LeaseIdMismatchWithLeaseOperation, "Określony identyfikator dzierżawy nie był zgodny z identyfikatorem dzierżawy zasobu z określoną operacją dzierżawy.
  • 409 Konflikt, LeaseIsAlreadyBroken, "Dzierżawa została już przerwana i nie można go złamać ponownie."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeAcquired: "Identyfikator dzierżawy jest zgodny, ale dzierżawa jest obecnie w stanie przerwania i nie można jej uzyskać, dopóki nie zostanie przerwana".
  • 409 Konflikt, LeaseIsBreakingAndCannotBeChanged, "Identyfikator dzierżawy jest zgodny, ale dzierżawa jest obecnie w stanie przerwania i nie można jej zmienić".
  • 409 Konflikt, LeaseIsBrokenAndCannotBeRenewed, "Identyfikator dzierżawy został dopasowany, ale dzierżawa została jawnie przerwana i nie można jej odnowić".
  • 409 Konflikt, LeaseNameMismatch, "Określona nazwa dzierżawy nie jest zgodna z istniejącą nazwą dzierżawy".
  • Konflikt 409, LeaseNotPresentWithLeaseOperation, "Identyfikator dzierżawy nie jest obecny w określonej operacji dzierżawy".
  • 409 Konflikt, PathAlreadyExists, "Określona ścieżka już istnieje".
  • 409 Konflikt, PathConflict, "Określona ścieżka lub element ścieżki istnieje, a jego typ zasobu jest nieprawidłowy dla tej operacji".
  • 409 Conflict, SourcePathIsBeingDeleted, "Określona ścieżka źródłowa jest oznaczona do usunięcia."
  • 409 Konflikt, ResourceTypeMismatch, "Typ zasobu określony w żądaniu nie jest zgodny z typem zasobu.
  • 412 Warunek wstępny nie powiodł się, ConditionNotMet, "Warunek określony przy użyciu nagłówków warunkowych HTTP nie jest spełniony."
  • 412 Warunek wstępny nie powiodło się, LeaseIdMismatch, "Określony identyfikator dzierżawy nie był zgodny z identyfikatorem dzierżawy zasobu."
  • 412 Warunek wstępny nie powiodło się, LeaseIdMissing: "Obecnie istnieje dzierżawa zasobu i nie określono identyfikatora dzierżawy w żądaniu."
  • 412 Warunek wstępny nie powiodło się, DzierżawaNotPresent: "Obecnie nie ma dzierżawy zasobu".
  • 412 Warunek wstępny nie powiódł się, LeaseLost, "Określono identyfikator dzierżawy, ale dzierżawa zasobu wygasła".
  • 412 Warunek wstępny nie powiodł się, SourceConditionNotMet, "Warunek źródłowy określony przy użyciu nagłówków warunkowych HTTP nie jest spełniony."
  • 413 Request Entity Too Large (Zbyt duża jednostka żądania, RequestBodyTooLarge), "Treść żądania jest zbyt duża i przekracza maksymalny dopuszczalny limit".
  • 416 Żądany zakres nie jest satisfiable, InvalidRange, "Określony zakres jest nieprawidłowy dla bieżącego rozmiaru zasobu."
  • 500 Wewnętrzny błąd serwera, InternalError, "Serwer napotkał błąd wewnętrzny. Ponów próbę żądania".
  • 500 Wewnętrzny błąd serwera, OperationTimedOut, "Nie można ukończyć operacji w dozwolonym czasie".
  • 503 Usługa niedostępna, ServerBusy, "Ruch wychodzący przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Ruch przychodzący przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Operacje na sekundę przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Serwer nie może obecnie odbierać żądań. Ponów próbę żądania".

Nagłówki

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

Definicje

Nazwa Opis
DataLakeStorageError
Error

Obiekt odpowiedzi na błąd usługi.
PathLeaseAction

Istnieją pięć akcji dzierżawy: "acquire", "break", "change", "renew" i "release". Użyj polecenia "acquire" i określ wartości "x-ms-proposed-lease-id" i "x-ms-lease-duration", aby uzyskać nową dzierżawę. Użyj opcji "break", aby przerwać istniejącą dzierżawę. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w którym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w pliku. Gdy dzierżawa zostanie pomyślnie przerwana, odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy. Użyj polecenia "change" i określ bieżący identyfikator dzierżawy w polu "x-ms-lease-id" i nowy identyfikator dzierżawy w polu "x-ms-proposed-lease-id", aby zmienić identyfikator dzierżawy aktywnej. Użyj polecenia "renew" i określ wartość "x-ms-lease-id", aby odnowić istniejącą dzierżawę. Użyj polecenia "release" i określ wartość "x-ms-lease-id", aby zwolnić dzierżawę.

DataLakeStorageError

Objekt
Nazwa Typ Opis
error

Error

Obiekt odpowiedzi na błąd usługi.

Error

Objekt

Obiekt odpowiedzi na błąd usługi.

Nazwa Typ Opis
code

string

Kod błędu usługi.
message

string

Komunikat o błędzie usługi.

PathLeaseAction

Wyliczanie

Istnieją pięć akcji dzierżawy: "acquire", "break", "change", "renew" i "release". Użyj polecenia "acquire" i określ wartości "x-ms-proposed-lease-id" i "x-ms-lease-duration", aby uzyskać nową dzierżawę. Użyj opcji "break", aby przerwać istniejącą dzierżawę. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w którym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w pliku. Gdy dzierżawa zostanie pomyślnie przerwana, odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy. Użyj polecenia "change" i określ bieżący identyfikator dzierżawy w polu "x-ms-lease-id" i nowy identyfikator dzierżawy w polu "x-ms-proposed-lease-id", aby zmienić identyfikator dzierżawy aktywnej. Użyj polecenia "renew" i określ wartość "x-ms-lease-id", aby odnowić istniejącą dzierżawę. Użyj polecenia "release" i określ wartość "x-ms-lease-id", aby zwolnić dzierżawę.

Wartość Opis
acquire
break
change
release
renew