パートナー センター REST と、パートナー センター REST API でサポートされる応答ヘッダー
に適用: パートナー センター |21Vianet が運営するパートナー センター |Microsoft Cloud for US Government のパートナー センター
パートナー センター REST API は、次の HTTP 要求ヘッダーと応答ヘッダーをサポートしています。 すべての API 呼び出しですべてのヘッダーを受け入れるわけではありません。
REST 要求ヘッダー
パートナー センター REST API では、次の HTTP 要求ヘッダーがサポートされています。
| ヘッダ | 説明 | 値の型 |
|---|---|---|
Authorization: |
必須。 ベアラー <トークン>形式の認可トークン。 | 糸 |
Accept: |
application/json |
糸 |
MS-RequestId: |
ID の効力を確保するために使用される、呼び出しの一意の識別子。 タイムアウトがある場合、再試行呼び出しには同じ値を含める必要があります。 応答 (成功またはビジネスエラー) を受信したら、次の呼び出しの値をリセットする必要があります。 | GUID |
MS-CorrelationId: |
エラーのトラブルシューティングに役立つ、呼び出しの一意の識別子。ログとネットワーク トレースで役立ちます。 この値は、すべての呼び出しに対してリセットする必要があります。 すべての操作にこのヘッダーを含める必要があります。 詳細については、「テストおよびデバッグの関連付け ID の情報を参照してください。 | GUID |
MS-Contract-Version: |
必須。 要求された API のバージョンを指定します。この値は、通常、api-version: v1 です。ただし、「シナリオ」セクションで特に指定がない限りです。 | 糸 |
If-Match: |
コンカレンシー制御に使用されます。 一部の API 呼び出しでは、If-Match ヘッダー経由で ETag を渡す必要があります。 ETag は通常リソース上にあるため、最新の GET を使用する必要があります。 詳細については、「Test and debugの ETag 情報を参照してください。 | 糸 |
MS-PartnerCenter-Application |
随意。 パートナー センター REST API を使用しているアプリケーションの名前を指定します。 | 糸 |
X-Locale: |
随意。 レートが返される言語を指定します。 既定値は en-USです。 サポートされている値の一覧については、パートナー センターでサポートされている言語とロケール |
糸 |
REST 応答ヘッダー
パートナー センター REST API は、次の HTTP 応答ヘッダーを返す場合があります。
| ヘッダ | 説明 | 値の型 |
|---|---|---|
Accept: |
application/json |
糸 |
MS-RequestId: |
ID の効力を確保するために使用される、呼び出しの一意の識別子。 タイムアウトがある場合、再試行呼び出しには同じ値を含める必要があります。 応答 (成功またはビジネスエラー) を受信したら、次の呼び出しの値をリセットする必要があります。 | GUID |
MS-CorrelationId: |
呼び出しの一意識別子。 この値は、エラーを見つけるためのログとネットワーク トレースのトラブルシューティングに役立ちます。 この値は、すべての呼び出しに対してリセットする必要があります。 すべての操作にこのヘッダーを含める必要があります。 | GUID |