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