Экспорт (0) Печать
Развернуть все

TPM OM API: Запрос заголовков ответа

Обновлено: Ноябрь 2013 г.

API OM TPM предоставляет пользователям возможность отправлять HTTP-запросы на создание сущностей OM TPM на основе протокола OData и получать ответы в подробном формате JSON, atom+pub или прямом XML. Поскольку API OM TPM соответствует правилам проектирования Azure, существует ряд обязательных заголовков HTTP, которые должен использовать каждый клиент при подключении к конечной точке REST API OM TPM, а также ряд дополнительных заголовков, которые могут использоваться. В следующих разделах описываются заголовки и HTTP-команды, которые можно использовать в API OM TPM.

Каждый вызов в конечные точки REST API OM TPM должен включать ряд обязательных заголовков, а также по желанию ряд дополнительных заголовков. В следующей таблице описываются обязательные заголовки.

Обязательные заголовки

 

Заголовок Тип Значение

Авторизация

Токены ACS WRAP

Значение должно включать токен доступа, предоставленный Microsoft Azure Active Directory Access Control (также называется Access Control Service или ACS). Инструкции по извлечению токена ACS с помощью протокола WRAP см. по адресу http://msdn.microsoft.com/library/windowsazure/hh674475.aspx.

Host

Строка

Задает узел и номер порта целевого ресурса.

DataServiceVersion

Десятичное число

1.0

MaxDataServiceVersion

Десятичное число

3.0

x-ms-version

Десятичное число

1.0

If-Match

Тег сущности

Указывает, что операция выполняется только в том случае, если тег сущности, заданный в заголовке запроса, соответствует тегу сущности объекта.

noteПримечание
Этот заголовок требуется только при выполнении операций обновления или удаления.

noteПримечание
Поскольку API OM TPM использует протокол OData для предоставления своего базового репозитория метаданных ресурсов через API REST, заголовки DataServiceVersion и MaxDataServiceVersion должны включаться в любой запрос; однако если они не включены, то в настоящее время API OM TPM предполагает, что используется значение 1.0 DataServiceVersion.

Дополнительные заголовки

 

Заголовок Тип Значение

Дата

Дата RFC 1123

Метка времени запроса.

Accept

Тип содержимого

Запрошенный тип содержимого для ответа, например следующий:

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip, deflate

Шифрование GZIP и DEFLATE, где это применимо.

Accept-Language

"en", "es" и т. п.

Задает предпочтительный язык ответа.

Accept-Charset

Тип набора символов, например UTF-8

Значение по умолчанию — UTF-8.

X-HTTP-Method

Метод HTTP

Позволяет клиентам или брандмауэрам, не поддерживающим такие методы HTTP, как PUT или DELETE, использовать эти методы, туннелированные посредством вызова GET.

Content-Type

Тип содержимого

Тип содержимого текста запроса в запросах POST и PUT.

Далее приводятся заголовки, которые могут быть вам возвращены в зависимости от запрошенного ресурса и действия, которое вы собирались выполнить.

 

Заголовок Тип Значение

Дата

Дата RFC 1123

Дата обработки запроса

Content-Type

Разный

Тип содержимого текста ответа.

Content-Encoding

Разный

Gzip или deflate, по обстоятельствам

Cache-Control

-

Указывает, могут ли механизмы кэширования, от сервера до клиента, кэшировать объект.

Content-Length

Тип содержимого

Длина текста ответа.

Server

-

Имя сервера.

X-Content-Type-Options

Тип содержимого

Единственное возможное значение "nonsniff" запрещает браузерам выполнять сканирование MIME ответа из объявленного типа содержимого.

Далее приводится полный список HTTP-команд, которые поддерживаются API OM TPM и могут использоваться при выполнении HTTP-запросов.

 

КОМАНДА Описание

GET

Возвращает текущее значение для сущности.

POST

Создает объект (или выдает команду) на основе предоставленных данных.

PUT

Заменяет объект или создает новый объект (где это применимо).

DELETE

Удаляет объект.

MERGE

Обновляет объект с использованием изменений указанного свойства.

Показ:
© 2014 Microsoft