RouteRequestRouteMatrixSync200Response interface

參考

套件:: @azure-rest/maps-route

適用于：請參閱定價層。

矩陣路由服務允許使用非同步 (非同步) 或同步 (同步) POST 要求，計算來源和目的地位置所定義的一組路由路由摘要矩陣。針對每個指定的來源，服務會計算從該來源路由到每個指定目的地的成本。原點集合和目的地集合可以視為資料表的資料行和資料列標頭，而資料表中的每個資料格都包含從來源路由到該儲存格目的地的成本。例如，假設一家食物遞送公司有 20 個驅動程式，他們需要尋找最接近的驅動程式，才能從餐廳挑選遞送。若要解決此使用案例，他們可以呼叫矩陣路由 API。

針對每個路線，會傳回行進時間和距離。您可以使用計算成本來判斷要使用路線方向 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 適用于處理大量相對複雜的路由要求。當您使用非同步要求提出要求時，服務預設會傳回 202 回應碼，並在回應標頭的 [位置] 欄位中傳回重新導向 URL。應該定期檢查此 URL，直到回應資料或錯誤資訊可用為止。如果 waitForResults 要求中的參數設定為 true，如果使用者要求在 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}

以下是一般非同步作業序列：

用戶端會將路由矩陣 POST 要求傳送至 Azure 地圖服務
伺服器會以下列其中一項回應：

HTTP 202 Accepted - 已接受路由矩陣要求。

HTTP Error - 處理路由矩陣要求時發生錯誤。這可能是 400 不正確的要求或任何其他錯誤狀態碼。
如果已成功接受矩陣路由要求，回應中的 Location 標頭會包含下載要求結果的 URL。此狀態 URI 如下所示：

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

用戶端會在步驟 3 取得的下載 URL 上發出 GET 要求，以下載結果

下載同步處理結果

當您對路由矩陣同步 API 提出 POST 要求時，服務會傳回 200 回應碼以取得成功的要求和回應陣列。回應本文將包含資料，而且稍後將無法擷取結果。

下載非同步結果

當要求發出 202 Accepted 回應時，會使用我們的非同步管線來處理要求。系統會提供 URL，以在回應的位置標頭中檢查非同步要求的進度。此狀態 URI 如下所示：

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

位置標頭提供的 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

共用方式為