Udostępnij za pośrednictwem

Nagłówki REST i odpowiedzi obsługiwane przez REST API Centrum partnerskiego.

  • Artykuł

Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA

REST API Centrum Partnerskiego obsługuje następujące nagłówki żądań HTTP i odpowiedzi. Nie wszystkie wywołania interfejsu API akceptują wszystkie nagłówki.

Nagłówki żądań REST

Interfejs API REST Centrum partnerskiego obsługuje następujące nagłówki żądań HTTP.

Nagłówek Opis Typ wartości
Authorization: Wymagane. Token autoryzacji w formie Bearer <token>. struna
Accept: Określa typ żądania i odpowiedzi application/json. struna
MS-RequestId: Unikatowy identyfikator wywołania, używany do zapewnienia idempotencji. Jeśli występuje limit czasu, wywołanie ponawiania próby powinno zawierać tę samą wartość. Po otrzymaniu odpowiedzi (powodzenie lub niepowodzenie) wartość powinna zostać zresetowana przed następnym wywołaniem. GUID
MS-CorrelationId: Unikatowy identyfikator wywołania, przydatny w dziennikach i ścieżkach sieci w celu rozwiązywania problemów. Wartość powinna być resetowana przy każdym wywołaniu. Wszystkie operacje powinny zawierać ten nagłówek. Aby uzyskać więcej informacji, zobacz informacje o identyfikatorze korelacji w Testowanie i debugowanie. GUID
MS-Contract-Version: Wymagane. Określa wersję żądanego interfejsu API; Ta wartość jest zwykle wersją interfejsu API: v1, chyba że określono inaczej w sekcji Scenariusze. struna
If-Match: Służy do sterowania współbieżnością. Niektóre wywołania interfejsu API wymagają przekazania elementu ETag za pośrednictwem nagłówka If-Match. Element ETag jest zwykle na zasobie i dlatego wymaga wykonania żądania GET, aby pobrać najnowszą wersję. Aby uzyskać więcej informacji, zobacz informacje o ETag w Test and debug. struna
MS-PartnerCenter-Application Fakultatywny. Określa nazwę aplikacji korzystającej z interfejsu API REST centrum partnerskiego. struna
X-Locale: Fakultatywny. Określa język, w którym są zwracane stawki. Wartość domyślna to en-US. Aby uzyskać listę obsługiwanych wartości, zobacz Obsługiwane języki i ustawienia regionalne w Centrum partnerskim. struna

Nagłówki odpowiedzi REST

Interfejs API REST Centrum partnerskiego może zwracać następujące nagłówki odpowiedzi HTTP.

Nagłówek Opis Typ wartości
Accept: Określa typ żądania i odpowiedzi application/json. struna
MS-RequestId: Unikatowy identyfikator wywołania, używany do zapewnienia idempotencji. Jeśli występuje limit czasu, wywołanie ponawiania próby powinno zawierać tę samą wartość. Po otrzymaniu odpowiedzi (sukces lub porażka biznesowa) wartość powinna zostać zresetowana dla następnego wywołania. GUID
MS-CorrelationId: Jednoznaczny identyfikator wywołania. Ta wartość jest przydatna do rozwiązywania problemów z dziennikami i śladami sieci w celu znalezienia błędu. Wartość powinna zostać zresetowana przy każdym wywołaniu. Wszystkie operacje powinny zawierać ten nagłówek. GUID (Globalnie Unikalny Identyfikator)