Share via

Path - Lease

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

Lånesökväg
Skapa och hantera ett lån för att begränsa skriv- och borttagningsåtkomst till sökvägen. Den här åtgärden stöder villkorsstyrda HTTP-begäranden. Mer information finns i Ange villkorsstyrda rubriker för Blob Service-åtgärder.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}

URI-parametrar

Name I Obligatorisk Typ Description
accountName
 path True

string

Namnet på Azure Storage-kontot.
dnsSuffix
 path True

string

DNS-suffixet för Azure Data Lake Storage-slutpunkten.
filesystem
 path True

string

Filsystemidentifieraren.

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

string

Fil- eller katalogsökvägen.
timeout
 query

integer

int32

Ett valfritt timeoutvärde för åtgärden i sekunder. Perioden börjar när begäran tas emot av tjänsten. Om tidsgränsvärdet förflutit innan åtgärden slutförs misslyckas åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-lease-action True

PathLeaseAction

Det finns fem låneåtgärder: "acquire", "break", "change", "renew" och "release". Använd "acquire" och ange "x-ms-proposed-lease-id" och "x-ms-lease-duration" för att skaffa ett nytt lån. Använd "break" för att bryta ett befintligt lån. När ett lån bryts kan låneperioden förflutit, under vilken tid ingen låneåtgärd förutom avbrott och lansering kan utföras på filen. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas. Använd "ändra" och ange aktuellt låne-ID i "x-ms-lease-id" och det nya låne-ID:t i "x-ms-proposed-lease-id" för att ändra låne-ID för ett aktivt lån. Använd "förnya" och ange "x-ms-lease-id" för att förnya ett befintligt lån. Använd "release" och ange "x-ms-lease-id" för att frigöra ett lån.
x-ms-lease-duration

integer

int32

Lånetiden krävs för att skaffa ett lån och anger lånets varaktighet i sekunder. Lånetiden måste vara mellan 15 och 60 sekunder eller -1 för oändligt lån.
x-ms-lease-break-period

integer

int32

Varaktigheten för låneavbrottsperioden är valfri för att bryta ett lån och anger lånets brytperiod i sekunder. Låneperioden måste vara mellan 0 och 60 sekunder.
x-ms-lease-id

string

Krävs när "x-ms-lease-action" är "renew", "change" eller "release". För förnyelse- och lanseringsåtgärderna måste detta matcha det aktuella låne-ID:t.

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

string

Krävs när "x-ms-lease-action" är "acquire" eller "change". Ett lån förvärvas med det här låne-ID:t om åtgärden lyckas.

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

string

Valfritt. Ett ETag-värde. Ange det här huvudet för att utföra åtgärden endast om resursens ETag matchar det angivna värdet. ETag måste anges inom citattecken.
If-None-Match

string

Valfritt. Ett ETag-värde eller ett särskilt jokerteckenvärde ("*"). Ange den här rubriken för att utföra åtgärden endast om resursens ETag inte matchar det angivna värdet. ETag måste anges inom citattecken.
If-Modified-Since

string

Valfritt. Ett datum- och tidsvärde. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan det angivna datumet och tiden.
If-Unmodified-Since

string

Valfritt. Ett datum- och tidsvärde. Ange endast det här huvudet för att utföra åtgärden om resursen inte har ändrats sedan det angivna datumet och tiden.
x-ms-client-request-id

string

Ett UUID som registrerats i analysloggarna för felsökning och korrelation.

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

string

Anger Coordinated Universal Time (UTC) för begäran. Detta krävs när du använder auktorisering av delad nyckel.
x-ms-version

string

Anger versionen av REST-protokollet som används för bearbetning av begäran. Detta krävs när du använder auktorisering av delad nyckel.

Svar

Name Typ Description
200 OK

Åtgärden "renew", "change" eller "release" lyckades.

Headers

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

Ett nytt lån har skapats. Åtgärden "hämta" lyckades.

Headers

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

Låneåtgärden "break" lyckades.

Headers

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

DataLakeStorageError

Ett fel inträffade. De möjliga HTTP-status-, kod- och meddelandesträngarna visas nedan:

  • 400 Felaktig begäran, ContentLengthMustBeZero, "Rubriken för innehållslängdsbegäran måste vara noll".
  • 400 Felaktig begäran, InvalidAuthenticationInfo, "Autentiseringsinformation ges inte i rätt format. Kontrollera värdet för auktoriseringsrubriken."
  • 400 Felaktig begäran, InvalidFlushPosition, "Uppladdade data är inte sammanhängande eller värdet för frågeparametern position är inte lika med filens längd efter att de uppladdade data har lagts till."
  • 400 Felaktig begäran, InvalidHeaderValue, "Värdet för en av HTTP-huvudena är inte i rätt format."
  • 400 Felaktig begäran, InvalidHttpVerb, "Det angivna HTTP-verbet är ogiltigt – det känns inte igen av servern."
  • 400 Felaktig begäran, InvalidInput, "En av indata för begäran är inte giltig".
  • 400 Felaktig begäran, InvalidPropertyName, "Ett egenskapsnamn får inte vara tomt".
  • 400 Felaktig begäran, InvalidPropertyName, "Egenskapsnamnet innehåller ogiltiga tecken".
  • 400 Felaktig begäran, InvalidQueryParameterValue, "Värdet för en av frågeparametrarna som anges i begärans URI är ogiltigt".
  • 400 Felaktig begäran, InvalidResourceName, "Det angivna resursnamnet innehåller ogiltiga tecken".
  • 400 Felaktig begäran, InvalidSourceUri, "Käll-URI:n är ogiltig".
  • 400 Felaktig begäran, InvalidUri, "Begärande-URI:n är ogiltig".
  • 400 Felaktig begäran, MissingRequiredHeader, "Ett HTTP-huvud som är obligatoriskt för den här begäran har inte angetts."
  • 400 Felaktig begäran, MissingRequiredQueryParameter, "En frågeparameter som är obligatorisk för den här begäran har inte angetts.".
  • 400 Felaktig begäran, MultipleConditionHeadersNotSupported, "Flera villkorsrubriker stöds inte.".
  • 400 Felaktig begäran, OutOfRangeInput, "En av indata för begäran är inte inom intervallet."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "En av frågeparametrarna som anges i begärande-URI:n ligger utanför det tillåtna intervallet."
  • 400 Felaktig begäran, UnsupportedHeader, "En av huvudena som anges i begäran stöds inte."
  • 400 Felaktig begäran, UnsupportedQueryParameter, "En av frågeparametrarna som anges i begärans URI stöds inte."
  • 400 Felaktig begäran,RestVersion stöds inte, "Den angivna restversionen stöds inte".
  • 403 Förbjuden, AccountIsDisabled, "Det angivna kontot är inaktiverat".
  • 403 Förbjuden, AuthorizationFailure, "Denna begäran har inte behörighet att utföra den här åtgärden."
  • 403 Förbjudet, InsufficientAccountPermissions, "Kontot som används har inte tillräcklig behörighet för att köra den här åtgärden.".
  • 404 Hittades inte, FilesystemNotFound, "Det angivna filsystemet finns inte.".
  • 404 Hittades inte, PathNotFound, "Den angivna sökvägen finns inte".
  • 404 Hittades inte, RenameDestinationParentPathNotFound, "Målsökvägens överordnade katalog finns inte".
  • 404 Hittades inte, ResourceNotFound, "Den angivna resursen finns inte".
  • 404 Not Found, SourcePathNotFound, "Källsökvägen för en namnbytesåtgärd finns inte."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "Resursen stöder inte det angivna HTTP-verbet."
  • 409 Konflikt, DestinationPathIsBeingDeleted, "Den angivna målsökvägen markeras som borttagen".
  • 409 Konflikt, DirectoryNotEmpty, "Det rekursiva frågeparametervärdet måste vara sant för att ta bort en icke-tom katalog."
  • 409 Conflict, FilesystemAlreadyExists, "Det angivna filsystemet finns redan".
  • 409 Conflict, FilesystemBeingDeleted, "Det angivna filsystemet tas bort".
  • 409 Conflict, InvalidDestinationPath, "Den angivna sökvägen eller ett element i sökvägen finns och dess resurstyp är ogiltig för den här åtgärden." * 409 Conflict, InvalidFlushOperation, "Resursen skapades eller ändrades av Blob Service-API:et och kan inte skrivas till av Data Lake Storage Service-API:et."
  • 409 Conflict, InvalidRenameSourcePath, "Källkatalogen får inte vara samma som målkatalogen och kan inte heller vara en underkatalog till källkatalogen."
  • 409 Konflikt, InvalidSourceOrDestinationResourceType, "Käll- och målresurstypen måste vara identisk."
  • 409 Konflikt, LeaseAlreadyPresent, "Det finns redan ett lån."
  • 409 Konflikt, LeaseIdMismatchWithLeaseOperation, "Det angivna låne-ID:t matchade inte låne-ID:t för resursen med den angivna låneåtgärden."
  • 409 Konflikt, LeaseIsAlreadyBroken, "Lånet har redan brutits och kan inte brytas igen."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeAcquired, "Låne-ID matchade, men lånet är för närvarande i icke-bakåtkompatibelt tillstånd och kan inte förvärvas förrän det bryts."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeChanged, "Låne-ID matchade, men lånet är för närvarande i icke-bakåtkompatibelt tillstånd och kan inte ändras."
  • 409 Konflikt, LeaseIsBrokenAndCannotBeRenewed, "Låne-ID matchade, men lånet har brutits uttryckligen och kan inte förnyas."
  • 409 Konflikt, LeaseNameMismatch, "Det angivna lånenamnet matchade inte det befintliga lånenamnet."
  • 409 Konflikt, LeaseNotPresentWithLeaseOperation, "Låne-ID:t finns inte med den angivna låneåtgärden."
  • 409 Konflikt, PathAlreadyExists, "Den angivna sökvägen finns redan".
  • 409 Konflikt, PathConflict, "Den angivna sökvägen eller ett element i sökvägen finns och dess resurstyp är ogiltig för den här åtgärden."
  • 409 Conflict, SourcePathIsBeingDeleted, "Den angivna källsökvägen har markerats som borttagen".
  • 409 Konflikt, ResourceTypeMismatch, "Resurstypen som anges i begäran matchar inte resurstypen."
  • 412 Förhandsvillkoret misslyckades, ConditionNotMet, "Villkoret som anges med villkorsstyrda HTTP-huvuden är inte uppfyllt."
  • 412 Förhandsvillkoret misslyckades, LeaseIdMismatch, "Det angivna låne-ID:t matchade inte låne-ID:t för resursen."
  • 412 Förhandsvillkoret misslyckades, LeaseIdMissing, "Det finns för närvarande ett lån på resursen och inget låne-ID angavs i begäran."
  • 412 Förhandsvillkoret misslyckades, LeaseNotPresent, "Det finns för närvarande inget lån på resursen."
  • 412 Förhandsvillkoret misslyckades, LeaseLost, "Ett låne-ID angavs, men lånet för resursen har upphört att gälla."
  • 412 Förutsättning misslyckades, SourceConditionNotMet, "Källvillkoret som anges med villkorsstyrda HTTP-huvuden är inte uppfyllt."
  • 413 Begärandeentiteten är för stor, RequestBodyTooLarge, "Begärandetexten är för stor och överskrider den maximala tillåtna gränsen."
  • 416 Det begärda området är inte uppfyllt, InvalidRange, "Det angivna intervallet är ogiltigt för resursens aktuella storlek.".
  • 500 Internt serverfel, InternalError, "Servern påträffade ett internt fel. Försök igen."
  • 500 Internt serverfel, OperationTimedOut, "Det gick inte att slutföra åtgärden inom den tillåtna tiden."
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Utgående trafik överskrider kontogränsen".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Ingress is over the account limit".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Åtgärder per sekund överskrider kontogränsen".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Servern kan för närvarande inte ta emot begäranden. Försök igen."

Headers

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

Definitioner

Name Description
DataLakeStorageError
Error

Svarsobjektet för tjänstfel.
PathLeaseAction

Det finns fem låneåtgärder: "acquire", "break", "change", "renew" och "release". Använd "acquire" och ange "x-ms-proposed-lease-id" och "x-ms-lease-duration" för att skaffa ett nytt lån. Använd "break" för att bryta ett befintligt lån. När ett lån bryts kan låneperioden förflutit, under vilken tid ingen låneåtgärd förutom avbrott och lansering kan utföras på filen. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas. Använd "ändra" och ange aktuellt låne-ID i "x-ms-lease-id" och det nya låne-ID:t i "x-ms-proposed-lease-id" för att ändra låne-ID för ett aktivt lån. Använd "förnya" och ange "x-ms-lease-id" för att förnya ett befintligt lån. Använd "release" och ange "x-ms-lease-id" för att frigöra ett lån.

DataLakeStorageError

Name Typ Description
error

Error

Svarsobjektet för tjänstfel.

Error

Svarsobjektet för tjänstfel.

Name Typ Description
code

string

Felkoden för tjänsten.
message

string

Tjänstfelmeddelandet.

PathLeaseAction

Det finns fem låneåtgärder: "acquire", "break", "change", "renew" och "release". Använd "acquire" och ange "x-ms-proposed-lease-id" och "x-ms-lease-duration" för att skaffa ett nytt lån. Använd "break" för att bryta ett befintligt lån. När ett lån bryts kan låneperioden förflutit, under vilken tid ingen låneåtgärd förutom avbrott och lansering kan utföras på filen. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas. Använd "ändra" och ange aktuellt låne-ID i "x-ms-lease-id" och det nya låne-ID:t i "x-ms-proposed-lease-id" för att ändra låne-ID för ett aktivt lån. Använd "förnya" och ange "x-ms-lease-id" för att förnya ett befintligt lån. Använd "release" och ange "x-ms-lease-id" för att frigöra ett lån.

Name Typ Description
acquire

string

break

string

change

string

release

string

renew

string