Traffic - Get Traffic Flow Segment

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do uzyskiwania informacji na temat prędkości i czasów podróży określonego odcinka drogi.

Interfejs Traffic Flow Segment API to żądanie HTTP GET , które dostarcza informacji o szybkościach i porach podróży fragmentu drogi znajdującego się najbliżej podanych współrzędnych. Jest ona przeznaczona do pracy wraz z warstwą Flow usługi renderowania w celu obsługi wizualizacji danych przepływu z możliwością kliknięcia. Za pomocą interfejsu Traffic Flow Segment API po stronie klienta można połączyć dowolne miejsce na mapie z danymi przepływu w najbliższej drodze i przedstawić je użytkownikowi.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
query	query	True	number[]	Współrzędne punktu blisko odcinka drogi. Ten parametr jest listą czterech współrzędnych, zawierających dwie pary współrzędnych (lat, long, lat, long) i obliczane przy użyciu EPSG4326 projekcji. Gdy ten punkt końcowy jest wywoływany bezpośrednio, współrzędne są przekazywane jako pojedynczy ciąg zawierający cztery współrzędne oddzielone przecinkami.
style	query	True	TrafficFlowSegmentStyle	Styl używany do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające zmierzoną prędkość bezwzględną, względną, która zwraca szybkość względem swobodnego przepływu, względne opóźnienie, które wyświetla względne prędkości tylko wtedy, gdy różnią się od prędkości przepływu wolnego
zoom	query	True	integer int32	Poziom powiększenia dla żądanego kafelka. Wartość powiększenia musi należeć do zakresu: 0–22 (włącznie). Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatka kafelków .
openLr	query		boolean	Wartość logiczna określająca, czy odpowiedź powinna zawierać kod OpenLR
thickness	query		integer int32	Wartość szerokości linii reprezentującej ruch. Ta wartość jest mnożnikiem, a akceptowane wartości wahają się od 1 do 20. Wartość domyślna to 10.
unit	query		SpeedUnit	Jednostka prędkości w KMPH lub MPH

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ń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

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

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .

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 poziomu 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 skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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ółużytkowany podczas tworzenia konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list 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 AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Request traffic flow segment information

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Przykładowa odpowiedź

Kod stanu:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

Definicje

Nazwa	Opis
Coordinates	Zawiera współrzędne opisujące kształt segmentu. Współrzędne są przesuwane z drogi w zależności od poziomu powiększenia w celu obsługi wizualizacji o wysokiej jakości w każdej skali.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FlowSegmentData	Właściwość Dane segmentu przepływu
LatLongPair	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
ResponseFormat	Żądany format odpowiedzi. Wartość może być json lub xml.
SpeedUnit	Jednostka prędkości w KMPH lub MPH
TrafficFlowSegmentData	Ten obiekt jest zwracany z pomyślnego wywołania segmentu przepływu ruchu
TrafficFlowSegmentStyle	Styl używany do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające zmierzoną prędkość bezwzględną, względną, która zwraca szybkość względem swobodnego przepływu, względne opóźnienie, które wyświetla względne prędkości tylko wtedy, gdy różnią się od prędkości przepływu wolnego

Coordinates

Zawiera współrzędne opisujące kształt segmentu. Współrzędne są przesuwane z drogi w zależności od poziomu powiększenia w celu obsługi wizualizacji o wysokiej jakości w każdej skali.

Nazwa	Typ	Opis
coordinate	LatLongPair[]	Tablica współrzędnych

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 error.

FlowSegmentData

Właściwość Dane segmentu przepływu

Nazwa	Typ	Opis
@version	string	Wskazuje to wersję oprogramowania, która wygenerowała odpowiedź.
confidence	number	Pewność siebie jest miarą jakości zapewnianego czasu podróży i prędkości. Wartość 1 oznacza pełną pewność, że odpowiedź zawiera dane o najwyższej jakości. Niższe wartości wskazują stopień, w jaki odpowiedź może się różnić od rzeczywistych warunków na drodze. Każda wartość większa niż 0,6 oznacza, że informacje były oparte na danych wejściowych sondy w czasie rzeczywistym. Wartość 0,5 oznacza, że zgłoszona prędkość jest oparta na informacjach historycznych. Wartość z zakresu od 0,5 do 0,6 ma obliczoną średnią ważoną między prędkościami historycznymi i dynamicznymi.
coordinates	Coordinates	Zawiera współrzędne opisujące kształt segmentu. Współrzędne są przesuwane z drogi w zależności od poziomu powiększenia w celu obsługi wizualizacji o wysokiej jakości w każdej skali.
currentSpeed	integer	Bieżąca średnia prędkość w wybranym punkcie w żądanych jednostkach. Jest to obliczane na podstawie wartości currentTravelTime i długości wybranego segmentu.
currentTravelTime	integer	Bieżący czas podróży w sekundach, w tym segmencie ruchu, na podstawie połączonych pomiarów czasu rzeczywistego między zdefiniowanymi lokalizacjami w określonym kierunku.
frc	string	Klasa drogi funkcjonalnej. Wskazuje to typ drogi: 0: Autostrada, autostrada, autostrada lub inne główne drogi. 1: Główna droga, mniej ważna niż autostrada. 2: Inna główna droga. 3: Droga pomocnicza. 4: Lokalna droga łącząca. 5: Lokalna droga o wysokim znaczeniu. 6: Droga lokalna.
freeFlowSpeed	integer	Szybkość przepływu wolnego oczekiwana w idealnych warunkach wyrażona w żądanych jednostkach. Jest to związane z freeFlowTravelTime.
freeFlowTravelTime	integer	Czas podróży w sekundach w tym segmencie ruchu, który byłby oczekiwany w idealnych warunkach swobodnego przepływu.
openlr	string	Kod OpenLR dla segmentu. Zobacz OpenLR , aby uzyskać więcej informacji na temat korzystania z kodów Open LR.

LatLongPair

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.

Nazwa	Typ	Opis
latitude	number	Właściwość Szerokość geograficzna
longitude	number	Właściwość Długość geograficzna

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript
xml	string	The Extensible Markup Language

SpeedUnit

Jednostka prędkości w KMPH lub MPH

Nazwa	Typ	Opis
KMPH	string	Kilometry na godzinę
MPH	string	Mile na godzinę

TrafficFlowSegmentData

Ten obiekt jest zwracany z pomyślnego wywołania segmentu przepływu ruchu

Nazwa	Typ	Opis
flowSegmentData	FlowSegmentData	Właściwość Dane segmentu przepływu

TrafficFlowSegmentStyle

Styl używany do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające zmierzoną prędkość bezwzględną, względną, która zwraca szybkość względem swobodnego przepływu, względne opóźnienie, które wyświetla względne prędkości tylko wtedy, gdy różnią się od prędkości przepływu wolnego

Nazwa	Typ	Opis
absolute	string
relative	string
relative-delay	string

Udostępnij za pośrednictwem