Algemene Azure Cosmos DB REST-aanvraagheaders
De volgende aanvraagheaders zijn gebruikelijk voor alle taken die u met de SQL-API kunt uitvoeren:
| Header | Vereist | Type | Beschrijving |
|---|---|---|---|
| Autorisatie | Vereist | Tekenreeks | Het autorisatietoken voor de aanvraag. Zie Access Control op Cosmos DB-resources voor meer informatie over het genereren van een geldig autorisatietoken |
| Content-Type | Vereist (op PUT, PATCH en POST) | Tekenreeks | Voor POST op querybewerkingen moet dit application/query+json zijn. Voor PATCH-bewerkingen moet dit application/json_patch+json zijn. Voor bijlagen moet worden ingesteld op het Mime-type van de bijlage. Zie Een bijlage maken voor meer informatie over MIME-typen Voor alle andere taken moet toepassing/json zijn. |
| Als-overeenkomst | Optioneel (alleen van toepassing op PUT en DELETE) | Tekenreeks | Wordt gebruikt om bewerking voorwaardelijk te maken voor optimistische gelijktijdigheid. De waarde moet de etag-waarde van de resource zijn. |
| If-None-Match | Optioneel (alleen van toepassing op GET) | Tekenreeks | Maakt bewerking voorwaardelijk om alleen uit te voeren als de resource is gewijzigd. De waarde moet de etag van de resource zijn. |
| If-Modified-Since | Optioneel (alleen van toepassing op GET) | Date | Retourneert de etag van resource die is gewijzigd na de opgegeven datum in RFC 1123-indeling. Genegeerd wanneer If-None-Match is opgegeven |
| User-Agent | Optioneel | Tekenreeks | Een tekenreeks die de clientgebruikersagent aangeeft die de aanvraag uitvoert. De aanbevolen indeling is {user agent name}/{version}. De officiële SQL API .NET SDK stelt bijvoorbeeld de User-Agent tekenreeks in op Microsoft.Document.Client/1.0.0.0. Een aangepaste gebruikersagent kan iets zijn als ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Optioneel | Tekenreeks | Een door de client opgegeven id voor de bewerking, die wordt herhaald in het antwoord van de server. De aanbevolen waarde is een unieke id. |
| x-ms-consistency-level | Optioneel | Tekenreeks | Het consistentieniveau overschrijven voor leesopties voor documenten en bijlagen. De geldige waarden zijn: Sterk, Gebonden, Sessie of Uiteindelijk (in volgorde van sterk naar zwak). De onderdrukking moet hetzelfde of zwakker zijn dan het geconfigureerde consistentieniveau van het account. |
| x-ms-continuation | Optioneel | Tekenreeks | Een tekenreekstoken dat wordt geretourneerd voor query's en leesfeedbewerkingen als er meer resultaten moeten worden gelezen. Clients kunnen de volgende pagina met resultaten ophalen door de aanvraag opnieuw in te dienen met de aanvraagheader x-ms-continuation ingesteld op deze waarde. |
| x-ms-date | Vereist | Date | De datum van de aanvraag per RFC 1123-datumnotatie uitgedrukt in Coordinated Universal Time, bijvoorbeeld Vr, 08 apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Optioneel | Aantal | Een geheel getal dat het maximum aantal items aangeeft dat per pagina moet worden geretourneerd. Er kan een x-ms-max-item-count van -1 worden opgegeven om de service het optimale aantal items te laten bepalen. Dit is de aanbevolen configuratiewaarde voor x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Optioneel | Matrix | De partitiesleutelwaarde voor de aangevraagde document- of bijlagebewerking. Vereist voor bewerkingen op documenten en bijlagen wanneer de definitie van de verzameling een partitiesleuteldefinitie bevat. Deze waarde wordt gebruikt om het bereik van uw query te bepalen voor documenten die voldoen aan de criteria voor de partitiesleutel. Het is standaard een partitiequery. Ondersteund in API-versies 2015-12-16 en hoger. Momenteel ondersteunt de SQL-API één partitiesleutel, dus dit is een matrix die slechts één waarde bevat. |
| x-ms-documentdb-query-enablecrosspartition | Optioneel | Booleaans | Wanneer deze header is ingesteld op true en als uw query geen partitiesleutel heeft, wordt de query in Azure Cosmos DB op verschillende partities uitgebdat. Dit wordt gedaan door afzonderlijke query's op alle partities uit te voeren. Als u de queryresultaten wilt lezen, moeten de clienttoepassingen de resultaten van feedresponse gebruiken en controleren op de eigenschap ContinuationToken. Om alle resultaten te lezen, moet dit worden herhaald totdat de eigenschap ContinuationToken null is. |
| x-ms-session-token | Vereist (alleen voor sessieconsistentie) | Tekenreeks | Een tekenreekstoken dat wordt gebruikt met consistentie op sessieniveau. Zie voor meer informatie Consistentieniveaus gebruiken in Cosmos DB |
| x-ms-version | Vereist | Tekenreeks | De versie van de Cosmos DB REST-service. Zie Azure Cosmos DB REST API Reference (Naslaginformatie over azure Cosmos DB REST API) voor een lijst met ondersteunde API-versies |
| A-IM | Optioneel | Tekenreeks | Hiermee wordt een wijzigingsfeedaanvraag aangegeven. Moet worden ingesteld op Incrementele feed of anders worden weggelaten. |
| x-ms-documentdb-partitionkeyrangeid | Optioneel | Aantal | Wordt gebruikt in aanvragen voor wijzigingenfeeds . De partitiesleutelbereik-id voor het lezen van gegevens. |
| x-ms-cosmos-allow-tentative-writes | Optioneel | Booleaans | Wanneer deze header is ingesteld op true voor de Azure Cosmos-accounts die zijn geconfigureerd met meerdere schrijflocaties, staat Azure Cosmos DB schrijfbewerkingen naar alle locaties toe. Schrijfaanvragen waarvoor de waarde van deze header is ingesteld op false (of als de header ontbreekt) mislukken met de 403-antwoordstatuscode met het foutbericht 'Schrijfbewerkingen zijn niet toegestaan in de regio'. |
Zie ook