Заголовки

  • Статья

В этой статье приведены ссылки на справку по заголовкам, используемым в REST API конфигурации приложений Azure.

Заголовки запросов

В следующей таблице описаны общие заголовки запросов, используемые в конфигурации приложений Azure.

Header Описание Пример
Авторизация Используется для проверки подлинности запроса к службе. См. раздел 14.8 Authorization: HMAC-SHA256 Credential=<Credential>&SignedHeaders=Host;x-ms-date;x-ms-content-sha256&Signature=<Signature>
Принятие Информирует сервер о том, какой тип носителя будет принимать клиент в ответе HTTP. См. раздел 14.1 Accept: application/vnd.microsoft.appconfig.kv+json;
Accept-Datetime Запрашивает сервер вернуть его содержимое в виде представления его прежнего состояния. Значение этого заголовка является запрошенным значением даты и времени этого состояния. См. RFC 7089 Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT
Content-Type Содержит тип носителя содержимого в тексте HTTP-запроса. См. раздел 14.17 Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8;
Дата Дата и время выдачи HTTP-запроса. Этот заголовок используется в проверке подлинности HMAC. См. раздел 14.18 Date: Fri, 11 May 2018 18:48:36 GMT
Узел Указывает клиент, для которого был выдан запрос. Этот заголовок используется в проверке подлинности HMAC. См. раздел 14.23 Host: contoso.azconfig.io
If-Match Используется для выполнения условного запроса HTTP. Этот запрос должен быть выполнен, только если ETag целевого ресурса совпадает со значением этого заголовка. Значение "*" соответствует любому ETag. См. раздел 14.24 If-Match: "4f6dd610dd5e4deebc7fbaef685fb903"
If-None-Match Используется для выполнения условного запроса HTTP. Этот запрос должен быть выполнен, только если ETag целевого ресурса не совпадает со значением этого заголовка. Значение "*" соответствует любому ETag. См. раздел 14.26 If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903"
Sync-Token Используется для обеспечения согласованности в режиме реального времени во время последовательности запросов. Sync-Token: jtqGc1I4=MDoyOA==;sn=28
x-ms-client-request-id Уникальный идентификатор, предоставленный клиентом для наблюдения за циклическим обменом запроса. x-ms-client-request-id: 00000000-0000-0000-0000-000000000000
x-ms-content-sha256 Хэш-код sha256 текста HTTP-запроса. Этот заголовок используется в проверке подлинности HMAC. x-ms-content-sha256: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
x-ms-date Этот заголовок может быть установлен и использован вместо заголовка Date, если не удается получить доступ к заголовку даты. Этот заголовок используется в проверке подлинности HMAC. x-ms-date: Fri, 11 May 2018 18:48:36 GMT
x-ms-return-client-request-id Используется в сочетании с заголовком x-ms-client-request-id. Если значение этого заголовка равно true, серверу будет предложено вернуть значение заголовка запроса x-ms-client-request-id. x-ms-return-client-request-id: true

Заголовки откликов

Сервер может включать в ответы следующие заголовки HTTP.

Header Описание Пример
Content-Type Содержит тип носителя содержимого в тексте ответа HTTP. См. раздел 14.17 Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8;
ETag Непрозрачный токен, представляющий состояние данного ресурса. Может использоваться в условных операциях. См. раздел 14.19 ETag: "4f6dd610dd5e4deebc7fbaef685fb903"
Last-Modified Описывает, когда запрошенный ресурс был изменен. В формате HTTP-Date. См. раздел 14.29 Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT
Ссылка Содержит ссылки на ресурсы, связанные с ответом. Этот заголовок используется для разбиения на страницы с помощью ссылки Далее. См. RFC 5988 Link: </kv?after={token}>; rel="next"
Memento-Datetime Указывает, что содержимое в ответе представляет прежнее состояние. Значение этого заголовка является значением даты и времени этого состояния. См. RFC 7089 Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
retry-after-ms Предоставляет предполагаемый период ожидания клиентом (в миллисекундах) перед повторным выполнением невыполненного запроса. retry-after-ms: 10
x-ms-request-id Уникальный идентификатор, созданный сервером, который используется для отслеживания запроса в службе. x-ms-request-id: 00000000-0000-0000-0000-000000000000
WWW-Authenticate Используется для запроса клиентов на проверку подлинности и предоставления причины сбоя попытки проверки подлинности. См. раздел 14.47 WWW-Authenticate: HMAC-SHA256 error="invalid_token" error_description="Invalid Signature"