Поделиться через

Заголовки запросов и ответов REST, поддерживаемые API Центра партнеров

  • Статья

применимо к: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud для государственных организаций США

REST API Центра партнеров поддерживает следующие заголовки HTTP-запроса и ответа. Не все вызовы API принимают все заголовки.

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

REST API Центра партнеров поддерживает следующие заголовки HTTP-запроса.

Заголовок Описание Тип значения
Authorization: Обязательно. Токен авторизации в форме Bearer <токен>. струна
Accept: Указывает тип запроса и ответа, application/json. струна
MS-RequestId: Уникальный идентификатор для вызова, используемый для обеспечения идемпотентности. Если время ожидания истекло, вызов повторных попыток должен содержать то же значение. После получения ответа (успешного или бизнес-сбоя) значение должно быть сброшено для следующего вызова. GUID
MS-CorrelationId: Уникальный идентификатор вызова, полезный в журналах и трассировках сети для устранения ошибок. Значение должно сбрасываться для каждого вызова. Все операции должны включать этот заголовок. Для получения дополнительной информации см. сведения об идентификаторе корреляции в разделе Тестирование и отладка. GUID
MS-Contract-Version: Обязательно. Указывает версию запрошенного API; Обычно это значение является версией API: версия 1, если иное не указано в разделе Сценарии. струна
If-Match: Используется для управления параллелизмом. Для некоторых вызовов API требуется передача ETag через заголовок If-Match. ETag обычно находится на ресурсе, поэтому требуется выполнить GET-запрос для получения последней версии. Дополнительную информацию см. в данных об ETag в разделе Тестирование и отладка. струна
MS-PartnerCenter-Application Необязательный. Указывает имя приложения, использующего REST API Центра партнеров. струна
X-Locale: Необязательный. Указывает язык, в котором возвращаются ставки. Значение по умолчанию — en-US. См. список поддерживаемых значений в разделе поддерживаемые языки и языковые стандарты Центра партнеров. струна

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

REST API Центра партнеров может возвращать следующие заголовки ответа HTTP.

Заголовок Описание Тип значения
Accept: Указывает тип запроса и ответа, application/json. струна
MS-RequestId: Уникальный идентификатор для вызова, используемый для обеспечения идемпотентности. Если время ожидания истекло, вызов повторных попыток должен содержать то же значение. После получения ответа (успешного или ошибки в бизнес-процессе) значение следует сбросить для следующего вызова. GUID
MS-CorrelationId: Уникальный идентификатор для вызова. Это значение полезно для устранения неполадок журналов и трассировок сети для поиска ошибки. Значение должно быть сброшено при каждом вызове. Все операции должны включать этот заголовок. GUID