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

  • Artykuł

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

Interfejs API REST 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 są obsługiwane przez interfejs API REST Centrum partnerskiego.

Nagłówek opis Typ wartości
Autoryzacja: Wymagany. Token autoryzacji w tokenie elementu nośnego <>formularza. string
Zaakceptować: Określa typ żądania i odpowiedzi, application/json. string
MS-RequestId: Unikatowy identyfikator wywołania, używany do zapewnienia mocy id-potencji. Jeśli występuje limit czasu, wywołanie ponawiania próby powinno zawierać tę samą wartość. Po otrzymaniu odpowiedzi (powodzenie lub niepowodzenie biznesowe) wartość powinna zostać zresetowana do następnego wywołania. Identyfikator GUID
MS-CorrelationId: Unikatowy identyfikator wywołania, przydatny w dziennikach i śladach sieci w celu rozwiązywania problemów z błędami. Wartość powinna zostać zresetowana dla każdego wywołania. Wszystkie operacje powinny zawierać ten nagłówek. Aby uzyskać więcej informacji, zobacz informacje o identyfikatorze korelacji w temacie Testowanie i debugowanie. Identyfikator GUID
MS-Contract-Version: Wymagany. Określa wersję żądanego interfejsu API; Ta wartość jest zwykle api-version: v1, chyba że określono inaczej w sekcji Scenariusze . string
Dopasowanie warunkowe: 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 w zasobie i dlatego wymaga pobrania najnowszej wersji. Aby uzyskać więcej informacji, zobacz artykuł ETag information in Test and debug (Testowanie i debugowanie). string
MS-PartnerCenter-Application Opcjonalny. Określa nazwę aplikacji korzystającej z interfejsu API REST Centrum partnerskiego. string
Ustawienia regionalne X: Opcjonalny. 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. string

Nagłówki odpowiedzi REST

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

Nagłówek opis Typ wartości
Zaakceptować: Określa typ żądania i odpowiedzi, application/json. string
MS-RequestId: Unikatowy identyfikator wywołania, używany do zapewnienia mocy id-potencji. Jeśli występuje limit czasu, wywołanie ponawiania próby powinno zawierać tę samą wartość. Po otrzymaniu odpowiedzi (powodzenie lub niepowodzenie biznesowe) wartość powinna zostać zresetowana do następnego wywołania. Identyfikator GUID
MS-CorrelationId: Unikatowy 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 dla każdego wywołania. Wszystkie operacje powinny zawierać ten nagłówek. Identyfikator GUID