Spatial - Get Great Circle Distance

Använd för att fastställa det kortaste avståndet mellan två punkter på ytan av en sfär.

API:et Get Great Circle Distance är en HTTP-begäran GET som returnerar den stora cirkeln eller det kortaste avståndet mellan två punkter på ytan av en sfär, mätt längs ytan av sfären. Detta skiljer sig från att beräkna en rak linje genom sfärens inre. Den här metoden är användbar för att beräkna reseavstånd för flygplan genom att beräkna det kortaste avståndet mellan flygplatser.

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

URI-parametrar

Name I Obligatorisk Typ Description
format
path True

JsonFormat

Önskat format för svaret. Endast json format stöds.

geography
path True

string

Platsen för Azure Maps-kontot. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). Den här parametern krävs när en udid anges i begäran. Om Azure Maps-kontot till exempel finns i USA, östra accepteras endast begäranden till oss geografi.

api-version
query True

string

Versionsnummer för Azure Maps API.

query
query True

string

Koordinaterna som avståndet beräknas genom, avgränsat med ett kolon. Två koordinater krävs. Den första är källpunktkoordinaten och den sista är målpunktkoordinaten. Till exempel 47.622942,122.316456:57.673988,127.121513

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Svar

Name Typ Description
200 OK

GreatCircleDistanceResult

OK

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Webb-SDK för Azure Maps möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst till Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

GetGreatCircleDistance

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

GreatCircleDistanceResult

Det här objektet returneras från ett lyckat great circle distance-anrop

GreatCircleDistanceSummary

Sammanfattningsobjekt

JsonFormat

Önskat format för svaret. Endast json format stöds.

LatLongPairAbbreviated

En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".

Result

Punkt i polygonresultatobjekt

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GreatCircleDistanceResult

Det här objektet returneras från ett lyckat great circle distance-anrop

Name Typ Description
result

Result

Resultatobjekt

summary

GreatCircleDistanceSummary

Sammanfattningsobjekt

GreatCircleDistanceSummary

Sammanfattningsobjekt

Name Typ Description
sourcePoint

LatLongPairAbbreviated

En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".

targetPoint

LatLongPairAbbreviated

En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name Typ Description
json

string

Datautbytesformat för JavaScript-objektnotation

LatLongPairAbbreviated

En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".

Name Typ Description
lat

number

Latitude-egenskap

lon

number

Longitudegenskap

Result

Punkt i polygonresultatobjekt

Name Typ Description
intersectingGeometries

string[]

Matris för geometrier

pointInPolygons

boolean

Egenskapen Punkt i polygoner