Spatial - Get Great Circle Distance

Reference

Služba:: Maps

Verze rozhraní API:: 2022-08-01

Slouží k určení nejkratší vzdálenosti mezi dvěma body na povrchu koule.

Rozhraní Get Great Circle Distance API je požadavek HTTP GET , který vrací velkou nebo nejkratší vzdálenost mezi dvěma body na povrchu koule měřenou podél povrchu koule. To se liší od výpočtu přímky vnitřku koule. Tato metoda je užitečná pro odhad cestovních vzdáleností letadel pomocí výpočtu nejkratší vzdálenosti mezi letišti.

GET https://{geography}.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query={query}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze `json` formát.
geography	path	True	string	Umístění účtu Azure Maps Platné hodnoty jsou us (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). Tento parametr je povinný, pokud `udid` je v požadavku zadán parametr . Pokud se například účet Azure Maps nachází v oblasti USA – východ, budou přijímány pouze žádosti o geografickou polohu.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
query	query	True	string	Souřadnice, přes které se vzdálenost počítá, oddělené dvojtečku. Vyžadují se dvě souřadnice. První je souřadnice zdrojového bodu a poslední je souřadnice cílového bodu. Například 47,622942,122.316456:57.673988,127.121513

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps najdete v následujících článcích .

Odpovědi

Name	Typ	Description
200 OK	GreatCircleDistanceResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Toto je sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.

U veřejně vystavených aplikací doporučujeme používat přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

GetGreatCircleDistance

Ukázkový požadavek

HTTP

GET https://us.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query=47.622942,-122.316456:47.610378,-122.200676

Ukázková odpověď

Stavový kód:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "targetPoint": {
      "lat": 47.610378,
      "lon": -122.200676
    }
  },
  "result": {
    "distanceInMeters": 8797.62
  }
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
GreatCircleDistanceResult	Tento objekt se vrátí z úspěšného volání vzdálenosti velkého kruhu.
GreatCircleDistanceSummary	Souhrnný objekt
JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze `json` formát.
LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
Result	Bod v objektu výsledku mnohoúhelníku

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GreatCircleDistanceResult

Tento objekt se vrátí z úspěšného volání vzdálenosti velkého kruhu.

Name	Typ	Description
result	Result	Objekt Result
summary	GreatCircleDistanceSummary	Souhrnný objekt

GreatCircleDistanceSummary

Souhrnný objekt

Name	Typ	Description
sourcePoint	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
targetPoint	LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat v zápisu objektů JavaScriptu

LatLongPairAbbreviated

Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

Name	Typ	Description
lat	number	Vlastnost Zeměpisná šířka
lon	number	Zeměpisná délka – vlastnost

Result

Bod v objektu výsledku mnohoúhelníku

Name	Typ	Description
intersectingGeometries	string[]	Matice geometrií
pointInPolygons	boolean	Point in Polygons – vlastnost

Sdílet prostřednictvím