次の方法で共有

RouteRequestRouteMatrixSync200Response interface

  • リファレンス
パッケージ:
@azure-rest/maps-route

適用対象: 価格 レベルを参照してください。

マトリックス ルーティング サービスを使用すると、非同期 (非同期) または同期 (同期) POST 要求を使用して、配信元と宛先の場所によって定義された一連のルートのルート概要のマトリックスを計算できます。 指定された配信元ごとに、サービスは、その配信元から特定のすべての宛先へのルーティングのコストを計算します。 一連の配信元と宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、配信元からそのセルの宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配達を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算コストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 です (配信元の数に宛先の数を乗算)。

同期ルート マトリックス要求を送信する

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは 100 です (配信元の数に宛先の数を掛けた値)。 この制約を念頭に置いて、考えられる行列ディメンションの例は、10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドにリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求のパラメーターが true に設定されている場合 waitForResults 、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは 700 です (配信元の数に宛先の数を乗算)。 この制約を念頭に置いて、考えられる行列ディメンションの例は、50x10、10x10、28x25 です。 10x70 (正方形である必要はありません)。

非同期応答は 14 日間格納されます。 リダイレクト URL は、有効期限が切れた後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

  1. クライアントが Route Matrix POST 要求を Azure Maps に送信する

  2. サーバーは、次のいずれかの応答を行います。

    HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

    HTTP Error - Route Matrix 要求の処理中にエラーが発生しました。 これは、400 無効な要求またはその他のエラー状態コードのいずれかです。

  3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. クライアントは、手順 3 で取得したダウンロード URL に GET 要求を発行して結果をダウンロードします

同期結果のダウンロード

Route Matrix Sync API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれており、後で結果を取得することはできません。

非同期結果のダウンロード

要求が応答を 202 Accepted 発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認するための URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、要求が発行されたときに次の応答を GET 返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

Extends
HttpResponse

プロパティ

body
status

継承されたプロパティ

headers

HTTP 応答ヘッダー。
request

この応答を生成した要求。

プロパティの詳細

body 

body: RouteMatrixResultOutput

プロパティ値

RouteMatrixResultOutput

status 

status: "200"

プロパティ値

"200"

継承されたプロパティの詳細

headers

HTTP 応答ヘッダー。

headers: RawHttpHeaders

プロパティ値

RawHttpHeaders

継承元 HttpResponse.headers

request

この応答を生成した要求。

request: PipelineRequest

プロパティ値

PipelineRequest

継承元 HttpResponse.request