Spatial - Get Great Circle Distance

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 2022-08-01

Służy do określania najkrótszej odległości między dwoma punktami na powierzchni sfery.

Interfejs Get Great Circle Distance API jest żądaniem HTTP GET , które zwraca wielką lub najkrótszą odległość między dwoma punktami na powierzchni sfery, mierzoną wzdłuż powierzchni sfery. Różni się to od obliczania prostej linii przez wnętrze sfery. Ta metoda jest przydatna do szacowania odległości podróży dla samolotów przez obliczanie najkrótszej odległości między portami lotniczymi.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
geography	path	True	string	Lokalizacja konta usługi Azure Maps. Prawidłowe wartości to nas (Wschodnie stany USA, Zachodnie stany USA, Zachodnie stany USA 2) i eu (Europa Północna, Europa Zachodnia). Ten parametr jest wymagany, gdy `udid` element jest dostarczany w żądaniu. Jeśli na przykład konto usługi Azure Maps znajduje się w regionie Wschodnie stany USA, akceptowane będą tylko żądania dotyczące lokalizacji geograficznej.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
query	query	True	string	Współrzędne, przez które jest obliczana odległość, rozdzielana dwukropkiem. Wymagane są dwie współrzędne. Pierwszy to współrzędna punktu źródłowego, a ostatni to współrzędna punktu docelowego. Na przykład 47.622942,122.316456:57.673988,127.121513

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GreatCircleDistanceResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia zasobu usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwera do serwera interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

GetGreatCircleDistance

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GreatCircleDistanceResult	Ten obiekt jest zwracany z pomyślnego wywołania o dużej odległości okręgu
GreatCircleDistanceSummary	Obiekt podsumowania
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
Result	Punkt w obiekcie wyniku wielokąta

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GreatCircleDistanceResult

Ten obiekt jest zwracany z pomyślnego wywołania o dużej odległości okręgu

Nazwa	Typ	Opis
result	Result	Result, obiekt
summary	GreatCircleDistanceSummary	Obiekt podsumowania

GreatCircleDistanceSummary

Obiekt podsumowania

Nazwa	Typ	Opis
sourcePoint	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
targetPoint	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

Nazwa	Typ	Opis
lat	number	Właściwość Szerokość geograficzna
lon	number	Właściwość Długość geograficzna

Result

Punkt w obiekcie wyniku wielokąta

Nazwa	Typ	Opis
intersectingGeometries	string[]	Tablica geometrii
pointInPolygons	boolean	Właściwość Punkt w wielokątach

Udostępnij za pośrednictwem