Spatial - Get Great Circle Distance

Referencia

Service:: Maps

API Version:: 2022-08-01

A következőkre vonatkozik: lásd: tarifacsomagok.

Ez az API a gömb felszínén lévő két pont közötti nagy kört vagy a legrövidebb távolságot adja vissza, a gömb felszínén mérve. Ez különbözik a gömb belsején keresztüli egyenes kiszámításától. Ez a módszer hasznos a repülők utazási távolságának becsléséhez a repülőterek közötti legrövidebb távolság kiszámításával.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
geography	path	True	string	A Azure Maps-fiók helye. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, USA 2. nyugati régiója) és az EU (Észak-Európa, Nyugat-Európa). Erre a paraméterre akkor van szükség, ha a `udid` kérelemben egy meg van adva. Ha például a Azure Maps-fiók az USA keleti régiójában található, akkor csak a földrajzra vonatkozó kérések lesznek elfogadva.
api-version	query	True	string	A Azure Maps API verziószáma.
query	query	True	string	Azok a koordináták, amelyeken keresztül a távolság kiszámítása történik, kettősponttal elválasztva. Két koordinátára van szükség. Az első a forráspont koordinátája, az utolsó pedig a célpont koordinátája. Például: 47.622942,122.316456:57.673988,127.121513

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Azure AD biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. Ha Azure AD biztonságot szeretne használni Azure Maps tekintse meg az alábbi cikkeket.

Válaszok

Name	Típus	Description
200 OK	GreatCircleDistanceResult	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps erőforrást hoz létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a Azure Maps REST API-k kiszolgálóról kiszolgálóra való hozzáférését, ahol ez a kulcs biztonságosan tárolható.

Type: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Type: apiKey
In: header

Példák

GetGreatCircleDistance

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GreatCircleDistanceResult	Ezt az objektumot egy sikeres Nagy Kör távolság hívása adja vissza
GreatCircleDistanceSummary	Összegző objektum
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.
Result	Pont a sokszög eredményobjektumában

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GreatCircleDistanceResult

Ezt az objektumot egy sikeres Nagy Kör távolság hívása adja vissza

Name	Típus	Description
result	Result	Eredményobjektum
summary	GreatCircleDistanceSummary	Összegző objektum

GreatCircleDistanceSummary

Összegző objektum

Name	Típus	Description
sourcePoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.
targetPoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript-objektum jelölési adatcseréjének formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

Name	Típus	Description
lat	number	Latitude tulajdonság
lon	number	Hosszúság tulajdonság

Result

Pont a sokszög eredményobjektumában

Name	Típus	Description
intersectingGeometries	string[]	Geometriai tömb
pointInPolygons	boolean	Pont a sokszögek tulajdonságában