Typowe nagłówki żądań REST usługi Azure Cosmos DB

Następujące nagłówki żądań są wspólne dla wszystkich zadań, które można wykonać za pomocą interfejsu API SQL:

Nagłówek Wymagany Typ Opis
Autoryzacja Wymagane Ciąg Token autoryzacji dla żądania. Aby uzyskać więcej informacji na temat generowania prawidłowego tokenu autoryzacji, zobacz Access Control na temat zasobów usługi Cosmos DB
Typ zawartości Wymagane (na PUT, PATCH i POST) Ciąg W przypadku operacji post dotyczących zapytań musi to być aplikacja/zapytanie+json.

W przypadku operacji PATCH musi być to aplikacja/json_patch+json.

W przypadku załączników należy ustawić typ Mime załącznika. Aby uzyskać więcej informacji na temat typów mime, zobacz Tworzenie załącznika

W przypadku wszystkich innych zadań musi być plik application/json.
Dopasowanie w przypadku Opcjonalnie (dotyczy tylko PUT i DELETE) Ciąg Służy do warunkowego działania na potrzeby optymistycznej współbieżności. Wartość powinna być wartością etag zasobu.
If-None-Match Opcjonalnie (dotyczy tylko get) Ciąg Wykonuje operację warunkową tylko wtedy, gdy zasób uległ zmianie. Wartość powinna być tagiem zasobu.
If-Modified-Since Opcjonalnie (dotyczy tylko get) Data Zwraca element etag zasobu zmodyfikowany po określonej dacie w formacie RFC 1123. Ignorowane, gdy określono wartość If-None-Match
User-Agent Opcjonalne Ciąg Ciąg określający agenta użytkownika klienta wykonującego żądanie. Zalecany format to {nazwa agenta użytkownika}/{wersja}. Na przykład oficjalny zestaw SDK platformy .NET interfejsu API SQL ustawia ciąg User-Agent na Wartość Microsoft.Document.Client/1.0.0.0. Niestandardowy agent użytkownika może być podobny do ContosoMarketingApp/1.0.0.
x-ms-activity-id Opcjonalne Ciąg Klient dostarczył identyfikator operacji, która jest powtarzana w odpowiedzi serwera. Zalecana wartość jest unikatowym identyfikatorem.
x-ms-consistency-level Opcjonalne Ciąg Poziom spójności zastępuje opcje odczytu dla dokumentów i załączników. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności najsilniejszej do najsłabszej). Przesłonięcia muszą być takie same lub słabsze niż skonfigurowany poziom spójności konta.
x-ms-kontynuacja Opcjonalne Ciąg Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. Klienci mogą pobrać następną stronę wyników, ponownie przesyłając żądanie z nagłówkiem żądania x-ms-kontynuacji ustawionym na tę wartość.
x-ms-date Wymagane Data Data żądania na format daty RFC 1123 wyrażony w uniwersalnym czasie koordynowanym, na przykład pt, 08 apr 2015 03:52:31 GMT.
x-ms-max-item-count Opcjonalne Liczba Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. Można określić x-ms-max-item-count -1, aby umożliwić usłudze określenie optymalnej liczby elementów. Jest to zalecana wartość konfiguracji x-ms-max-item-count
x-ms-documentdb-partitionkey Opcjonalne Tablica Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. Wymagane w przypadku operacji względem dokumentów i załączników, gdy definicja kolekcji zawiera definicję klucza partycji. Ta wartość służy do określania zakresu zapytania do dokumentów spełniających kryteria klucza partycji. Zgodnie z projektem jest to pojedyncze zapytanie partycji. Obsługiwane w interfejsie API w wersjach 2015-12-16 i nowszych. Obecnie interfejs API SQL obsługuje pojedynczy klucz partycji, więc jest to tablica zawierająca tylko jedną wartość.
x-ms-documentdb-query-enablecrosspartition Opcjonalne Wartość logiczna Gdy ten nagłówek ma wartość true i jeśli zapytanie nie ma klucza partycji, usługa Azure Cosmos DB wyeksymalizuje zapytanie między partycjami. Pojedyncze zapytania są wysyłane do wszystkich partycji. Aby odczytać wyniki zapytania, aplikacje klienckie powinny korzystać z wyników z elementu FeedResponse i sprawdzić właściwość ContinuationToken. Aby odczytać wszystkie wyniki, należy przeprowadzać iteracje na danych do momentu przybrania wartości null przez właściwość ContinuationToken.
x-ms-session-token Wymagane (tylko dla spójności sesji) Ciąg Token ciągu używany ze spójnością na poziomie sesji. Aby uzyskać więcej informacji, zobacz
Używanie poziomów spójności w bazie danych Cosmos
x-ms-version Wymagane Ciąg Wersja usługi REST Cosmos DB.
Aby uzyskać listę obsługiwanych wersji interfejsu API, zobacz Dokumentacja interfejsu API REST usługi Azure Cosmos DB
A-IM Opcjonalne Ciąg Wskazuje żądanie zestawienia zmian . Musi być ustawiona na wartość "Kanał informacyjny przyrostowy" lub pominięta w przeciwnym razie.
x-ms-documentdb-partitionkeyrangeid Opcjonalne Liczba Używane w żądaniach zestawienia zmian . Identyfikator zakresu kluczy partycji do odczytywania danych.
x-ms-cosmos-allow-tentative-writes Opcjonalne Wartość logiczna Jeśli ten nagłówek ma wartość true dla kont usługi Azure Cosmos skonfigurowanych z wieloma lokalizacjami zapisu, usługa Azure Cosmos DB będzie zezwalać na zapisy we wszystkich lokalizacjach. Żądania zapisu z wartością tego nagłówka mają wartość false (lub jeśli nagłówek jest nieobecny) zakończy się niepowodzeniem z kodem stanu odpowiedzi 403 z komunikatem o błędzie "Zapisy nie są dozwolone w regionie".

Zobacz też