Lijstbereiken
De List Ranges
bewerking retourneert de lijst met geldige bereiken voor een bestand.
Protocol beschikbaarheid
Bestandsshareprotocol ingeschakeld | Beschikbaar |
---|---|
SMB | |
NFS |
Aanvraag
U kunt de List Ranges
aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime>&comp=rangelist |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist&snapshot=<DateTime>&prevsharesnapshot=<DateTime> |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist&prevsharesnapshot=<DateTime> |
HTTP/1.1 |
Vervang de padonderdelen die in de aanvraag-URI worden weergegeven, als volgt door uw eigen onderdelen:
Padonderdeel | Description |
---|---|
myaccount |
De naam van uw opslagaccount. |
myshare |
De naam van de bestandsshare. |
mydirectorypath |
Optioneel. Het pad naar de bovenliggende map. |
myfile |
De naam van het bestand. |
Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie over beperkingen voor padnamen.
URI-parameters
U kunt de volgende aanvullende parameters opgeven voor de aanvraag-URI.
Parameter | Beschrijving |
---|---|
sharesnapshot |
Optioneel. Versie 2017-04-17 en hoger. De sharesnapshot parameter is een ondoorzichtige DateTime waarde die, indien aanwezig, de momentopname van de share aangeeft waarop een query moet worden uitgevoerd voor het bestand. |
timeout |
Optioneel. De timeout parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files bewerkingen voor meer informatie. |
prevsharesnapshot |
Optioneel in versie 2020-02-10 en hoger. De prevsharesnapshot parameter is een ondoorzichtige DateTime waarde die, indien aanwezig, de vorige momentopname aangeeft.Wanneer zowel deze parameter sharesnapshot als aanwezig zijn, bevat het antwoord alleen paginabereiken die zijn gewijzigd tussen de twee momentopnamen. Wanneer alleen prevsharesnapshot aanwezig is, bevat het antwoord alleen paginabereiken die zijn gewijzigd tussen deze momentopname en de liveshare.Gewijzigde pagina's bevatten zowel bijgewerkte als gewiste pagina's. |
Aanvraagheaders
In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.
Aanvraagheader | Beschrijving |
---|---|
Authorization |
Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie. |
Date of x-ms-date |
Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie. |
x-ms-version |
Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie. |
Range |
Optioneel. Hiermee geeft u het bereik van bytes waarover bereik, inclusief. Als u dit weglaat, worden alle bereiken voor het bestand geretourneerd. |
x-ms-range |
Optioneel. Hiermee geeft u het bereik van bytes waarover bereik, inclusief. Als zowel de Range headers als x-ms-range zijn opgegeven, gebruikt de service de waarde van x-ms-range . Zie De bereikheader opgeven voor Azure Files bewerkingen voor meer informatie. |
x-ms-lease-id:<ID> |
Optioneel. Versie 2019-02-02 en hoger. Als de header is opgegeven, wordt de bewerking alleen uitgevoerd als de lease van het bestand momenteel actief is en de lease-id die is opgegeven in de aanvraag overeenkomt met die van het bestand. Anders mislukt de bewerking met statuscode 412 (voorwaarde mislukt). |
x-ms-client-request-id |
Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Files bewaken voor meer informatie. |
x-ms-file-request-intent |
Vereist als Authorization de header een OAuth-token opgeeft. Acceptabele waarde is backup . Deze header geeft aan dat de Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action of Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action moet worden verleend als deze zijn opgenomen in het RBAC-beleid dat is toegewezen aan de identiteit die is geautoriseerd met behulp van de Authorization header. Beschikbaar voor versie 2022-11-02 en hoger. |
x-ms-allow-trailing-dot: { <Boolean> } |
Optioneel. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een volgpunt in de aanvraag-URL moet worden ingekort of niet. Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie. |
Aanvraagbody
Geen.
Antwoord
Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst in XML-indeling.
Statuscode
Een geslaagde bewerking retourneert statuscode 200 (OK). Zie Status- en foutcodes voor meer informatie over statuscodes.
Antwoordheaders
Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook extra, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.
Antwoordheader | Description |
---|---|
Last-Modified |
De datum/tijd waarop het bestand voor het laatst is gewijzigd. Elke bewerking die het bestand wijzigt, inclusief een update van de metagegevens of eigenschappen van het bestand, wijzigt de laatste wijzigingstijd van het bestand. |
ETag |
De ETag bevat een waarde die de versie van het bestand vertegenwoordigt, tussen aanhalingstekens. |
x-ms-content-length |
De grootte van het bestand in bytes. Wanneer prevsharesnapshot aanwezig is, beschrijft de waarde de grootte van het bestand op de sharesnapshot (als de sharesnapshot queryparameter aanwezig is). Anders wordt de grootte van het livebestand beschreven. |
x-ms-request-id |
Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossen voor meer informatie. |
x-ms-version |
Geeft de versie van Azure Files gebruikt om de aanvraag uit te voeren. |
Date of x-ms-date |
Een UTC-datum/tijd-waarde die de tijd aangeeft waarop het antwoord is gestart. De service genereert deze waarde. |
x-ms-client-request-id |
U kunt deze header gebruiken om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de x-ms-client-request-id header, als deze aanwezig is in de aanvraag. De waarde is maximaal 1024 zichtbare ASCII-tekens. Als de x-ms-client-request-id header niet aanwezig is in de aanvraag, is deze header niet aanwezig in het antwoord. |
Hoofdtekst van de reactie
De antwoordtekst bevat een lijst met niet-overlappende geldige bereiken, gesorteerd op het vergroten van het adresbereik. De indeling van de hoofdtekst van het antwoord is als volgt.
<?xml version="1.0" encoding="utf-8"?>
<Ranges>
<Range>
<Start>Start Byte</Start>
<End>End Byte</End>
</Range>
<Range>
<Start>Start Byte</Start>
<End>End Byte</End>
</Range>
</Ranges>
Als de volledige set bereiken van het bestand is gewist, bevat de antwoordtekst geen bereiken.
Als prevsharesnapshot
is opgegeven, bevat het antwoord alleen de pagina's die verschillen tussen de doelmomentopname (of het livebestand) en de vorige momentopname. De geretourneerde bereiken bevatten beide bereiken die zijn bijgewerkt of die zijn gewist. De indeling van dit antwoord is als volgt:
<?xml version="1.0" encoding="utf-8"?>
<Ranges>
<Range>
<Start>Start Byte</Start>
<End>End Byte</Start>
</Range>
<ClearRange>
<Start>Start Byte</Start>
<End>End Byte</Start>
</ClearRange>
<Range>
<Start>Start Byte</Start>
<End>End Byte</Start>
</Range>
</Ranges>
Als de volledige set pagina's van het bestand is gewist en de prevsharesnapshot
parameter niet is opgegeven, bevat de antwoordtekst geen bereiken.
Autorisatie
Alleen de accounteigenaar kan deze bewerking aanroepen.
Opmerkingen
De begin- en eind-byte offsets voor elk bereik zijn inclusief. Raadpleeg de voorbeelden van bereikupdatebewerkingen en bereikverklaarde bewerkingen voor Putbereik. Deze voorbeelden laten zien welke bereiken worden geretourneerd als u een niet-uitgelijnd bytebereik van 512 uit het bestand schrijft of wist.
In een zeer gefragmenteerd bestand met een groot aantal schrijfbewerkingen kan een List Ranges
aanvraag mislukken vanwege een interne servertime-out. Toepassingen die bereiken van een bestand met een groot aantal schrijfbewerkingen ophalen, moeten een subset van bereiken tegelijk ophalen.
Vanaf versie 2020-02-10 kunt u aanroepen List Ranges
met een prevsharesnapshot
parameter. Dit retourneert de bereiken die verschillen tussen het livebestand en een momentopname, of tussen twee momentopnamen van het bestand op momentopnamen. Met behulp van deze bereikverschillen kunt u een incrementele momentopname van een bestand ophalen. Incrementele momentopnamen zijn een kosteneffectieve manier om back-ups van bestanden te maken als u uw eigen back-upoplossing wilt implementeren.
Bepaalde bewerkingen op een bestand mislukken List Ranges
wanneer het wordt aangeroepen om een incrementele momentopname op te halen. De service retourneert:
- 404 (Niet gevonden) als u een bestand aanroept dat niet bestaat in een van de momentopnamen (of live, als
sharesnapshot
niet is opgegeven). - 409 (Conflict) als u een bestand aanroept dat het doel was van een overschrijvende kopie na de momentopname, opgegeven door
prevsharesnapshot
. - 409 (Conflict) als u een bestand aanroept dat is verwijderd en opnieuw is gemaakt met dezelfde naam en locatie, nadat de momentopname die is opgegeven door
prevsharesnapshot
is gemaakt.