Általános Azure Cosmos DB REST-kérésfejlécek
A következő kérésfejlécek az SQL API-val elvégezhető összes feladatra jellemzőek:
| Fejléc | Kötelező | Típus | Description |
|---|---|---|---|
| Engedélyezés | Kötelező | Sztring | A kérelem engedélyezési jogkivonata. Az érvényes engedélyezési jogkivonatok létrehozásával kapcsolatos további információkért lásd: Access Control a Cosmos DB-erőforrásokon |
| Tartalomtípus | Kötelező (PUT, PATCH és POST rendszeren) | Sztring | A POST lekérdezési műveletekhez application/query+json típusúnak kell lennie. A PATCH-műveletekhez application/json_patch+json fájlnak kell lennie. Mellékletek esetén a melléklet Mime típusának kell lennie. További információ a Mime-típusokról: Melléklet létrehozása Az összes többi tevékenységhez application/json típusúnak kell lennie. |
| If-Match | Nem kötelező (csak PUT és DELETE esetén alkalmazható) | Sztring | A művelet optimista egyidejűséghez való feltételessé tétele. Az értéknek az erőforrás etagértékének kell lennie. |
| If-None-Match | Nem kötelező (csak GET esetén alkalmazható) | Sztring | A műveletet feltételessé teszi, hogy csak akkor hajtsa végre, ha az erőforrás módosult. Az értéknek az erőforrás etagjének kell lennie. |
| If-Modified-Since | Nem kötelező (csak GET esetén alkalmazható) | Dátum | A megadott dátum után módosított erőforráscímkét adja vissza RFC 1123 formátumban. Figyelmen kívül hagyva, ha az If-None-Match paraméter meg van adva |
| User-Agent | Választható | Sztring | Egy sztring, amely meghatározza a kérést végrehajtó ügyfélfelhasználó ügynököt. Az ajánlott formátum a következő: {user agent name}/{version}. A hivatalos SQL API .NET SDK például a User-Agent sztringet Microsoft.Document.Client/1.0.0.0 értékre állítja. Az egyéni felhasználói ügynök a ContosoMarketingApp/1.0.0-hoz hasonló lehet. |
| x-ms-activity-id | Választható | Sztring | Az ügyfél megadta a művelet azonosítóját, amelyet a kiszolgáló válasza visszhangoz. A javasolt érték egy egyedi azonosító. |
| x-ms-consistency-level | Választható | Sztring | A dokumentumok és mellékletek olvasási beállításainak konzisztenciaszint-felülbírálása. Az érvényes értékek a következők: Erős, Kötött, Munkamenet vagy Végleges (a legerősebbtől a leggyengébbig). A felülbírálásnak meg kell egyeznie vagy gyengébbnek kell lennie, mint a fiók konfigurált konzisztenciaszintje. |
| x-ms-continuation | Választható | Sztring | A lekérdezésekhez és az olvasási hírcsatorna-műveletekhez visszaadott sztringtoken, ha több eredményt kell olvasni. Az ügyfelek úgy kérhetik le az eredmények következő oldalát, hogy újra beküldik a kérést az x-ms-continuation kérelem fejlécének erre az értékre van állítva. |
| x-ms-date | Kötelező | Dátum | A kérelem dátuma RFC 1123 dátumformátumban kifejezve az egyezményes világidőben, például 2015. április 8., péntek, 03:52:31 GMT. |
| x-ms-max-item-count | Választható | Szám | Egész szám, amely az egy oldalon visszaadandó elemek maximális számát jelzi. A -1 x-ms-max-item-count értéke megadhatja, hogy a szolgáltatás határozza meg az optimális elemszámot. Ez az x-ms-max-item-count ajánlott konfigurációs értéke |
| x-ms-documentdb-partitionkey | Választható | Tömb | A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke. A dokumentumokon és mellékleteken végzett műveletekhez szükséges, ha a gyűjteménydefiníció tartalmaz partíciókulcs-definíciót. Ez az érték a lekérdezés olyan dokumentumokra való hatókörének meghatározására szolgál, amelyek megfelelnek a partíciókulcs feltételeinek. A kialakításuk szerint ez egy partíciós lekérdezés. Az API 2015-12-16-os és újabb verzióiban támogatott. Az SQL API jelenleg egyetlen partíciókulcsot támogat, így ez egy tömb, amely csak egy értéket tartalmaz. |
| x-ms-documentdb-query-enablecrosspartition | Választható | Logikai | Ha ez a fejléc igaz értékre van állítva, és a lekérdezés nem rendelkezik partíciókulccsal, az Azure Cosmos DB támogatja a lekérdezést a partíciók között. A ventilátort úgy lehet kivenni, hogy egyéni lekérdezéseket ad ki az összes partícióra. A lekérdezési eredmények olvasásához az ügyfélalkalmazásoknak fel kell használniuk a FeedResponse eredményeit, és ellenőrizni kell a ContinuationToken tulajdonságot. Az összes eredmény olvasásához folytassa az iterálást az adatokon, amíg a ContinuationToken értéke null nem lesz. |
| x-ms-session-token | Kötelező (csak munkamenet-konzisztencia esetén) | Sztring | Munkamenetszintű konzisztenciával használt sztringtoken. További információkért lásd: Konzisztenciaszintek használata a Cosmos DB-ben |
| x-ms-version | Kötelező | Sztring | A Cosmos DB REST szolgáltatás verziója. A támogatott API-verziók listájáért lásd: Azure Cosmos DB REST API-referencia |
| A-IM | Választható | Sztring | Változáscsatorna-kérést jelez. "Növekményes hírcsatorna" értékre kell állítani, vagy másként nem adható meg. |
| x-ms-documentdb-partitionkeyrangeid | Választható | Szám | Változáscsatorna-kérelmekben használatos. A partíciókulcs tartományazonosítója az adatok olvasásához. |
| x-ms-cosmos-allow-feltételes-writes | Választható | Logikai | Ha ez a fejléc igaz értékre van állítva a több írási hellyel konfigurált Azure Cosmos-fiókok esetében, az Azure Cosmos DB minden helyre engedélyezi az írást. Ha a fejléc értéke hamis (vagy hiányzik a fejléc), a 403-at tartalmazó válaszállapot-kóddal meghiúsulnak a kérések, és a következő hibaüzenet jelenik meg: "Az írások nem engedélyezettek a régióban". |
Lásd még