Общие заголовки запросов REST в Azure Cosmos DB
Следующие заголовки запросов являются общими для всех задач, которые могут выполняться с помощью API SQL:
| Заголовок | Обязательно | Тип | Описание |
|---|---|---|---|
| авторизации | Обязательно | Струна | Маркер авторизации для запроса. Дополнительные сведения о создании допустимого маркера авторизации см. в разделе Управление доступом в ресурсах Cosmos DB |
| типа контента | Обязательный (в PUT, PATCH и POST) | Струна | Для операций запросов POST необходимо application/query+json. Для операций PATCH оно должно быть application/json_patch+json. Для вложений необходимо задать тип Mime вложения. Дополнительные сведения о типах Mime см. в разделе Создание вложения Для всех остальных задач должно быть application/json. |
| if-Match | Необязательный (применимо только для PUT и DELETE) | Струна | Используется для условного выполнения операции для оптимистического параллелизма. Значение должно быть значением etag ресурса. |
| If-None-Match | Необязательный (применимо только для GET) | Струна | Делает операцию условной для выполнения только в том случае, если ресурс изменился. Значение должно быть etag ресурса. |
| if-Modified-Since | Необязательный (применимо только для GET) | Дата | Возвращает etag ресурса, измененного после указанной даты в формате RFC 1123. Игнорируется при указании if-None-Match |
| пользователя | Необязательный | Струна | Строка, указывающая агент пользователя клиента, выполняющий запрос. Рекомендуемый формат — {имя агента пользователя}/{version}. Например, официальный пакет SDK ДЛЯ API SQL .NET задает для строки User-Agent значение Microsoft.Document.Client/1.0.0.0.0. Пользовательский агент пользователя может быть примерно таким, как ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Необязательный | Струна | Предоставленный клиентом идентификатор операции, который отображается в ответе сервера. Рекомендуемое значение — уникальный идентификатор. |
| уровня согласованности x-ms | Необязательный | Струна | Уровень согласованности переопределяется для параметров чтения для документов и вложений. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). Переопределение должно быть одинаковым или слабым, чем настроенный уровень согласованности учетной записи. |
| продолжения x-ms- | Необязательный | Струна | Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. Клиенты могут получить следующую страницу результатов, повторно предоставив запрос с заголовком запроса x-ms-продолжения, заданным для этого значения. |
| x-ms-date | Обязательно | Дата | Дата запроса в формате даты RFC 1123, выраженная в формате универсального времени в формате "Координированное универсальное время", например 08 апреля 2015 г. 03:52:31 GMT. |
| x-ms-max-item-count | Необязательный | Число | Целое число, указывающее максимальное количество возвращаемых элементов на страницу. Можно указать число элементов x-ms-max-item-count -1, чтобы позволить службе определить оптимальное количество элементов. Это рекомендуемое значение конфигурации для x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Необязательный | Массив | Значение ключа секции для запрошенной операции документа или вложения. Требуется для операций с документами и вложениями, когда определение коллекции включает определение ключа секции. Это значение используется для области запроса к документам, соответствующим критериям ключа секции. При проектировании это один запрос секции. Поддерживается в API версии 2015-12-16 и более поздних версий. В настоящее время API SQL поддерживает один ключ секции, поэтому это массив, содержащий только одно значение. |
| x-ms-documentdb-query-enablecrosspartition | Необязательный | Булев | Если для этого заголовка задано значение true, и если запрос не имеет ключа секции, azure Cosmos DB поддерживает запрос между секциями. Выдумка выполняется путем выдачи отдельных запросов ко всем секциям. Чтобы прочитать результаты запроса, клиентские приложения должны использовать результаты из FeedResponse и проверить свойство ExtensionToken. Чтобы считывать все результаты, продолжайте итерацию данных до тех пор, пока не будет значение Null. |
| x-ms-session-token | Обязательный (только для согласованности сеансов) | Струна | Строковый маркер, используемый с согласованность уровня сеанса. Дополнительные сведения см. в разделе Использование уровней согласованности в Cosmos DB |
| x-ms-version | Обязательно | Струна | Версия службы REST Cosmos DB. Список поддерживаемых версий API см. в справочнике по REST API Azure Cosmos DB |
| A-IM | Необязательный | Струна | Указывает канал изменений запроса. Должно быть задано значение "Добавочный канал" или опущено в противном случае. |
| x-ms-documentdb-partitionkeyrangeid | Необязательный | Число | Используется в веб-канале изменений запросов. Идентификатор диапазона ключей секции для чтения данных. |
| x-ms-cosmos-allow-tentative-writes | Необязательный | Булев | Если этот заголовок имеет значение true для учетных записей Azure Cosmos, настроенных с несколькими расположениями записи, Azure Cosmos DB разрешает запись во все расположения. Запросы на запись со значением этого заголовка, заданного значением false (или если заголовок отсутствует), завершится ошибкой с кодом состояния ответа 403 с сообщением об ошибке "Запись не разрешена в регионе". |
См. также