Dela via

RouteRequestRouteMatrix200Response interface

  • Referens
Paket:
@azure-rest/maps-route

Post Route Matrix-API:et är en HTTP-POST begäran som tillåter beräkning av en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprungs- och målplatser med hjälp av en asynkron (asynkron) begäran. Om du vill göra en synkron (synkron) begäran kan du läsa Synkronisering efter routningsmatris. För varje angivet ursprung beräknar tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Uppsättningen med ursprung och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. Låt oss till exempel säga att ett matleveransföretag har 20 förare och att de måste hitta den närmaste föraren för att hämta leveransen från restaurangen. För att lösa det här användningsfallet kan de anropa Matrix Route API.

För varje väg returneras restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka detaljerade vägar som ska beräknas med hjälp av API:et Routningsriktningar.

Den maximala storleken på en matris för asynkron begäran är 700 och för synkroniseringsbegäran är den 100 (antalet ursprung multiplicerat med antalet mål).

Obs!

Alla ursprung och mål ska finnas i en axeljusterad avgränsningsruta på 400 km x 400 km. Annars löses vissa matrisceller som OUT_OF_REGION.

Skicka begäran om synkron routningsmatris

Om ditt scenario kräver synkrona begäranden och matrisens maximala storlek är mindre än eller lika med 100, kanske du vill göra en synkron begäran. Den maximala storleken på en matris för det här API:et är 100 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 10x10, 6x8, 9x8 (det behöver inte vara kvadrat).

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

Skicka en asynkron routningsmatrisbegäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa routningsbegäranden. När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Om waitForResults parametern i begäran är inställd på true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder.

Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).

Asynkrona svar lagras i 24 timmar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

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

Här är en typisk sekvens med asynkrona åtgärder:

  1. Klienten skickar en POST-begäran om routningsmatris till Azure Maps

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Begäran om routningsmatris har godkänts.

    HTTP-Error – Ett fel uppstod när begäran om routningsmatris bearbetades. Detta kan antingen vara en 400 Felaktig begäran eller någon annan felstatuskod.

  3. Om matrisvägens begäran har godkänts innehåller platsrubriken i svaret URL:en för att ladda ned resultatet av begäran. Den här status-URI:n ser ut så här:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klienten utfärdar en GET-begäran om nedladdnings-URL:en som hämtas i steg 3 för att ladda ned resultatet

Ladda ned synkroniseringsresultat

När du gör en POST-begäran för API för routningsmatrissynkronisering returnerar tjänsten 200 svarskod för lyckad begäran och en svarsmatris. Svarstexten innehåller data och det finns ingen möjlighet att hämta resultaten senare.

Ladda ned Async-resultat

När en begäran utfärdar ett 202 Accepted svar bearbetas begäran med hjälp av vår asynkrona pipeline. Du får en URL för att kontrollera förloppet för din asynkrona begäran i svarets platsrubrik. Den här status-URI:n ser ut så här:

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

Url:en som tillhandahålls av platsrubriken returnerar följande svar när en GET begäran utfärdas.

HTTP-202 Accepted – Matrisbegäran godkändes men bearbetas fortfarande. Försök igen om en stund.

HTTP 200 OK – Matrisbegäran har bearbetats. Svarstexten innehåller alla resultat.

Extends
HttpResponse

Egenskaper

body
status

Ärvda egenskaper

headers

HTTP-svarshuvudena.
request

Begäran som genererade det här svaret.

Egenskapsinformation

body 

body: RouteMatrixResultOutput

Egenskapsvärde

RouteMatrixResultOutput

status 

status: "200"

Egenskapsvärde

"200"

Information om ärvda egenskaper

headers

HTTP-svarshuvudena.

headers: RawHttpHeaders

Egenskapsvärde

RawHttpHeaders

ärvd från HttpResponse.headers

request

Begäran som genererade det här svaret.

request: PipelineRequest

Egenskapsvärde

PipelineRequest

ärvd från HttpResponse.request