Share via

Path - Lease

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

Leasepad
Maak en beheer een lease om schrijf- en verwijderingstoegang tot het pad te beperken. Deze bewerking ondersteunt voorwaardelijke HTTP-aanvragen. Zie Voorwaardelijke headers opgeven voor blobservicebewerkingen voor meer informatie.

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

URI-parameters

Name In Vereist Type Description
accountName
 path True

string

De naam van het Azure Storage-account.
dnsSuffix
 path True

string

Het DNS-achtervoegsel voor het Azure Data Lake Storage-eindpunt.
filesystem
 path True

string

De bestandssysteem-id.

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

string

Het pad naar het bestand of de map.
timeout
 query

integer

int32

Een optionele time-outwaarde voor bewerkingen in seconden. De periode begint wanneer de aanvraag door de service wordt ontvangen. Als de time-outwaarde is verstreken voordat de bewerking is voltooid, mislukt de bewerking.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-lease-action True

PathLeaseAction

Er zijn vijf leaseacties: 'acquire', 'break', 'change', 'renew' en 'release'. Gebruik 'acquire' en geef de 'x-ms-proposed-lease-id' en 'x-ms-lease-duration' op om een nieuwe lease te verkrijgen. Gebruik 'break' om een bestaande lease te verbreken. Wanneer een lease wordt verbroken, mag de lease-onderbrekingsperiode verlopen, gedurende welke tijd geen leasebewerkingen kunnen worden uitgevoerd, behalve het verbreken en vrijgeven van het bestand. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen. Gebruik 'wijzigen' en geef de huidige lease-id op in 'x-ms-lease-id' en de nieuwe lease-id in 'x-ms-proposed-lease-id' om de lease-id van een actieve lease te wijzigen. Gebruik vernieuwen en geef de x-ms-lease-id op om een bestaande lease te verlengen. Gebruik 'release' en geef de 'x-ms-lease-id' op om een lease vrij te geven.
x-ms-lease-duration

integer

int32

De leaseduur is vereist voor het verkrijgen van een lease en geeft de duur van de lease in seconden op. De duur van de lease moet tussen 15 en 60 seconden zijn of -1 voor oneindige lease.
x-ms-lease-break-period

integer

int32

De duur van de lease-onderbreking is optioneel om een lease te verbreken en geeft de onderbrekingsperiode van de lease in seconden op. De duur van de lease-onderbreking moet tussen 0 en 60 seconden zijn.
x-ms-lease-id

string

Vereist wanneer 'x-ms-lease-action' 'vernieuwen', 'wijzigen' of 'vrijgeven' is. Voor de verlengings- en releaseacties moet dit overeenkomen met de huidige lease-id.

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

string

Vereist wanneer 'x-ms-lease-action' 'acquire' of 'change' is. Er wordt een lease verkregen met deze lease-id als de bewerking is geslaagd.

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

string

Optioneel. Een ETag-waarde. Geef deze header op om de bewerking alleen uit te voeren als de ETag van de resource overeenkomt met de opgegeven waarde. De ETag moet tussen aanhalingstekens worden opgegeven.
If-None-Match

string

Optioneel. Een ETag-waarde of de speciale jokertekenwaarde (*). Geef deze header op om de bewerking alleen uit te voeren als de ETag van de resource niet overeenkomt met de opgegeven waarde. De ETag moet tussen aanhalingstekens worden opgegeven.
If-Modified-Since

string

Optioneel. Een datum- en tijdwaarde. Geef deze header op om de bewerking alleen uit te voeren als de resource is gewijzigd sinds de opgegeven datum en tijd.
If-Unmodified-Since

string

Optioneel. Een datum- en tijdwaarde. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum en tijd.
x-ms-client-request-id

string

Een UUID die is vastgelegd in de analyselogboeken voor probleemoplossing en correlatie.

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

string

Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Dit is vereist bij het gebruik van autorisatie van gedeelde sleutels.
x-ms-version

string

Hiermee geeft u de versie van het REST-protocol op dat wordt gebruikt voor het verwerken van de aanvraag. Dit is vereist bij het gebruik van autorisatie van gedeelde sleutels.

Antwoorden

Name Type Description
200 OK

De actie 'vernieuwen', 'wijzigen' of 'vrijgeven' is geslaagd.

Headers

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

Er is een nieuwe lease gemaakt. De actie 'acquire' is geslaagd.

Headers

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

De actie 'einde' lease is geslaagd.

Headers

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

DataLakeStorageError

Er is een fout opgetreden. De mogelijke HTTP-status, code en berichttekenreeksen worden hieronder vermeld:

  • 400 Ongeldige aanvraag, ContentLengthMustBeZero, 'De aanvraagheader voor lengte van inhoud moet nul zijn'.
  • 400 Ongeldige aanvraag, InvalidAuthenticationInfo, "Verificatiegegevens worden niet in de juiste indeling gegeven. Controleer de waarde van autorisatieheader.'
  • 400 Ongeldige aanvraag, InvalidFlushPosition, "De geüploade gegevens zijn niet aaneengesloten of de waarde van de positiequeryparameter is niet gelijk aan de lengte van het bestand na het toevoegen van de geüploade gegevens."
  • 400 Ongeldige aanvraag, InvalidHeaderValue, 'De waarde voor een van de HTTP-headers heeft niet de juiste indeling'.
  • 400 Ongeldige aanvraag, OngeldigHttpVerb, 'Het opgegeven HTTP-werkwoord is ongeldig- het wordt niet herkend door de server'.
  • 400 Ongeldige aanvraag, InvalidInput, 'Een van de aanvraaginvoer is ongeldig'.
  • 400 Ongeldige aanvraag, InvalidPropertyName, 'De naam van een eigenschap mag niet leeg zijn'.
  • 400 Ongeldige aanvraag, InvalidPropertyName, 'De eigenschapsnaam bevat ongeldige tekens'.
  • 400 Ongeldige aanvraag, InvalidQueryParameterValue, 'Waarde voor een van de queryparameters die zijn opgegeven in de aanvraag-URI is ongeldig'.
  • 400 Ongeldige aanvraag, InvalidResourceName, 'De opgegeven resourcenaam bevat ongeldige tekens'.
  • 400 Ongeldige aanvraag, InvalidSourceUri, 'De bron-URI is ongeldig'.
  • 400 Ongeldige aanvraag, InvalidUri, 'De aanvraag-URI is ongeldig'.
  • 400 Ongeldige aanvraag, MissingRequiredHeader, 'Er is geen HTTP-header opgegeven die verplicht is voor deze aanvraag.'
  • 400 Ongeldige aanvraag, MissingRequiredQueryParameter, 'Er is geen queryparameter opgegeven die verplicht is voor deze aanvraag.'
  • 400 Ongeldige aanvraag, MultipleConditionHeadersNotSupported, 'Meerdere voorwaardeheaders worden niet ondersteund'.
  • 400 Ongeldige aanvraag, OutOfRangeInput, 'Een van de aanvraaginvoer ligt buiten het bereik'.
  • 400 Ongeldige aanvraag, OutOfRangeQueryParameterValue, 'Een van de queryparameters die zijn opgegeven in de aanvraag-URI valt buiten het toegestane bereik.'
  • 400 Ongeldige aanvraag, Niet ondersteundHeader, 'Een van de headers die in de aanvraag zijn opgegeven, wordt niet ondersteund'.
  • 400 Ongeldige aanvraag, UnsupportedQueryParameter, 'Een van de queryparameters die zijn opgegeven in de aanvraag-URI wordt niet ondersteund'.
  • 400 Ongeldige aanvraag, UnsupportedRestVersion, 'De opgegeven REST-versie wordt niet ondersteund'.
  • 403 Verboden, AccountIsDisabled, 'Het opgegeven account is uitgeschakeld'.
  • 403 Verboden, AuthorizationFailure, 'Deze aanvraag is niet gemachtigd om deze bewerking uit te voeren'.
  • 403 Forbidden, InsufficientAccountPermissions, "Het account dat wordt geopend, heeft niet voldoende machtigingen om deze bewerking uit te voeren."
  • 404 Niet gevonden, BestandssysteemNotFound, 'Het opgegeven bestandssysteem bestaat niet'.
  • 404 Niet gevonden, PathNotFound, 'Het opgegeven pad bestaat niet'.
  • 404 Niet gevonden, RenameDestinationParentPathNotFound, 'De bovenliggende map van het doelpad bestaat niet'.
  • 404 Niet gevonden, ResourceNotFound, 'De opgegeven resource bestaat niet'.
  • 404 Niet gevonden, SourcePathNotFound, 'Het bronpad voor een hernoembewerking bestaat niet'.
  • Methode 405 Niet toegestaan, Niet-ondersteundHttpVerb, 'De resource ondersteunt het opgegeven HTTP-werkwoord niet'.
  • 409 Conflict, DestinationPathIsBeingDeleted, 'Het opgegeven doelpad is gemarkeerd om te worden verwijderd'.
  • 409 Conflict, DirectoryNotEmpty, 'De waarde van de recursieve queryparameter moet waar zijn om een niet-lege map te verwijderen'.
  • 409 Conflict, FilesystemAlreadyExists, 'Het opgegeven bestandssysteem bestaat al'.
  • 409 Conflict, FilesystemBeingDeleted, 'Het opgegeven bestandssysteem wordt verwijderd'.
  • 409 Conflict, InvalidDestinationPath, 'Het opgegeven pad, of een element van het pad, bestaat en het resourcetype is ongeldig voor deze bewerking.' * 409 Conflict, InvalidFlushOperation, 'De resource is gemaakt of gewijzigd door de Blob Service-API en kan niet worden geschreven door de Data Lake Storage Service-API.'
  • 409 Conflict, InvalidRenameSourcePath, 'De bronmap mag niet hetzelfde zijn als de doelmap, noch kan de doelmap een submap van de bronmap zijn.'
  • 409 Conflict, InvalidSourceOrDestinationResourceType, 'Het bron- en doelresourcetype moet identiek zijn'.
  • 409 Conflict, LeaseAlreadyPresent, "Er is al een lease aanwezig."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "De opgegeven lease-id komt niet overeen met de lease-id voor de resource met de opgegeven leasebewerking."
  • 409 Conflict, LeaseIsAlreadyBroken, "De lease is al verbroken en kan niet opnieuw worden verbroken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "De lease-id komt overeen, maar de lease heeft momenteel de status Breken en kan niet worden verkregen totdat deze is verbroken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, 'De lease-id komt overeen, maar de lease heeft momenteel de status Breken en kan niet worden gewijzigd'.
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, 'De lease-id komt overeen, maar de lease is expliciet verbroken en kan niet worden vernieuwd'.
  • 409 Conflict, LeaseNameMismatch, "De opgegeven leasenaam komt niet overeen met de bestaande leasenaam."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, 'De lease-id is niet aanwezig bij de opgegeven leasebewerking'.
  • 409 Conflict, PathAlreadyExists, 'Het opgegeven pad bestaat al'.
  • 409 Conflict, PathConflict, "Het opgegeven pad of een element van het pad bestaat en het resourcetype is ongeldig voor deze bewerking."
  • 409 Conflict, SourcePathIsBeingDeleted, 'Het opgegeven bronpad is gemarkeerd om te worden verwijderd'.
  • 409 Conflict, ResourceTypeMismatch, 'Het resourcetype dat is opgegeven in de aanvraag komt niet overeen met het type van de resource.'
  • 412 Voorwaarde is mislukt, ConditionNotMet, "Aan de voorwaarde die is opgegeven met behulp van voorwaardelijke HTTP-header(s) wordt niet voldaan."
  • 412 Voorwaarde is mislukt, LeaseIdMismatch, "De opgegeven lease-id komt niet overeen met de lease-id voor de resource."
  • 412 Voorwaarde is mislukt, LeaseIdMissing, "Er is momenteel een lease voor de resource en er is geen lease-id opgegeven in de aanvraag."
  • 412 Voorwaarde is mislukt, LeaseNotPresent, "Er is momenteel geen lease voor de resource."
  • 412 Voorwaarde is mislukt, LeaseLost, 'Er is een lease-id opgegeven, maar de lease voor de resource is verlopen'.
  • 412 Voorwaarde is mislukt, SourceConditionNotMet, 'Er wordt niet voldaan aan de bronvoorwaarde die is opgegeven met behulp van voorwaardelijke HTTP-header(s).
  • 413 Aanvraagentiteit is te groot, RequestBodyTooLarge, "De aanvraagbody is te groot en overschrijdt de maximaal toegestane limiet."
  • 416 Aangevraagd bereik niet bevredigend, InvalidRange, 'Het opgegeven bereik is ongeldig voor de huidige grootte van de resource.'
  • 500 Interne serverfout, InternalError: 'Er is een interne fout opgetreden op de server. Probeer de aanvraag opnieuw.
  • 500 Interne serverfout, OperationTimedOut, 'De bewerking kan niet worden voltooid binnen de toegestane tijd.'
  • 503 Service niet beschikbaar, ServerBusy, 'Uitgaand verkeer heeft de accountlimiet overschreden'.
  • 503 Service niet beschikbaar, ServerBusy, 'Inkomend verkeer heeft de accountlimiet overschreden'.
  • 503 Service niet beschikbaar, ServerBusy, 'Bewerkingen per seconde is boven de accountlimiet'.
  • 503 Service niet beschikbaar, ServerBusy, "De server kan momenteel geen aanvragen ontvangen. Probeer uw aanvraag opnieuw.'

Headers

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

Definities

Name Description
DataLakeStorageError
Error

Het antwoordobject voor servicefouten.
PathLeaseAction

Er zijn vijf leaseacties: 'acquire', 'break', 'change', 'renew' en 'release'. Gebruik 'acquire' en geef de 'x-ms-proposed-lease-id' en 'x-ms-lease-duration' op om een nieuwe lease te verkrijgen. Gebruik 'break' om een bestaande lease te verbreken. Wanneer een lease wordt verbroken, mag de lease-onderbrekingsperiode verlopen, gedurende welke tijd geen leasebewerkingen kunnen worden uitgevoerd, behalve het verbreken en vrijgeven van het bestand. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen. Gebruik 'wijzigen' en geef de huidige lease-id op in 'x-ms-lease-id' en de nieuwe lease-id in 'x-ms-proposed-lease-id' om de lease-id van een actieve lease te wijzigen. Gebruik vernieuwen en geef de x-ms-lease-id op om een bestaande lease te verlengen. Gebruik 'release' en geef de 'x-ms-lease-id' op om een lease vrij te geven.

DataLakeStorageError

Name Type Description
error

Error

Het antwoordobject voor servicefouten.

Error

Het antwoordobject voor servicefouten.

Name Type Description
code

string

De foutcode van de service.
message

string

Het servicefoutbericht.

PathLeaseAction

Er zijn vijf leaseacties: 'acquire', 'break', 'change', 'renew' en 'release'. Gebruik 'acquire' en geef de 'x-ms-proposed-lease-id' en 'x-ms-lease-duration' op om een nieuwe lease te verkrijgen. Gebruik 'break' om een bestaande lease te verbreken. Wanneer een lease wordt verbroken, mag de lease-onderbrekingsperiode verlopen, gedurende welke tijd geen leasebewerkingen kunnen worden uitgevoerd, behalve het verbreken en vrijgeven van het bestand. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen. Gebruik 'wijzigen' en geef de huidige lease-id op in 'x-ms-lease-id' en de nieuwe lease-id in 'x-ms-proposed-lease-id' om de lease-id van een actieve lease te wijzigen. Gebruik vernieuwen en geef de x-ms-lease-id op om een bestaande lease te verlengen. Gebruik 'release' en geef de 'x-ms-lease-id' op om een lease vrij te geven.

Name Type Description
acquire

string

break

string

change

string

release

string

renew

string