Sdílet prostřednictvím

RouteRequestRouteMatrixSync200Response interface

  • Reference
Balíček:
@azure-rest/maps-route

Rozhraní API Post Route Matrix Sync je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí jediné synchronní (synchronizační) žádosti. Pokud chcete vytvořit asynchronní (asynchronní) požadavek, přečtěte si téma Post Route Matrix. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

Maximální velikost matice pro asynchronní požadavek je 700 a pro žádost o synchronizaci je 100 (počet původů vynásobený počtem cílů).

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 10x10, 6x8, 9x8 (nemusí být čtvercové).

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

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. Když provedete požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by se měla pravidelně kontrolovat, dokud nebudou k dispozici data odpovědí nebo informace o chybě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

Maximální velikost matice pro toto rozhraní API je 700 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 50x10, 10x10, 28x25. 10x70 (nemusí být čtvercový).

Asynchronní odpovědi se ukládají po dobu 24 hodin. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po uplynutí doby platnosti.

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

Tady je typická posloupnost asynchronních operací:

  1. Klient odešle požadavek POST směrovací matice do Služby Azure Maps.

  2. Server odpoví jedním z následujících způsobů:

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění v odpovědi obsahuje adresu URL pro stažení výsledků požadavku. Tento identifikátor URI stavu vypadá takto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient vydá požadavek GET na adresu URL pro stažení získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba kód odpovědi 200 pro úspěšný požadavek a pole odpovědí. Tělo odpovědi bude obsahovat data a později nebude možné výsledky načíst.

Stažení asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. Tento identifikátor URI stavu vypadá takto:

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

Adresa URL zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

HTTP 202 Accepted – Maticový požadavek byl přijat, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.

Extends
HttpResponse

Vlastnosti

body
status

Zděděné vlastnosti

headers

Hlavičky odpovědi HTTP.
request

Požadavek, který vygeneroval tuto odpověď.

Podrobnosti vlastnosti

body 

body: RouteMatrixResultOutput

Hodnota vlastnosti

RouteMatrixResultOutput

status 

status: "200"

Hodnota vlastnosti

"200"

Podrobnosti zděděných vlastností

headers

Hlavičky odpovědi HTTP.

headers: RawHttpHeaders

Hodnota vlastnosti

RawHttpHeaders

zděděno z httpResponse.headers

request

Požadavek, který vygeneroval tuto odpověď.

request: PipelineRequest

Hodnota vlastnosti

PipelineRequest

zděděno z HttpResponse.request