Traffic - Get Traffic Flow Segment

Odwołanie

Service:: Maps

API Version:: 1.0

Służy do uzyskiwania informacji o prędkościach i godzinach podróży określonej części drogi.

Interfejs Traffic Flow Segment API to żądanie HTTP GET , które zawiera informacje o szybkościach i czasie 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. Po stronie klienta po stronie interfejsu Traffic Flow Segment API można połączyć dowolne miejsce na mapie z danymi przepływu w najbliższej drodze i przedstawić go użytkownikowi.

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

With optional parameters:

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 Azure Maps.
query	query	True	number[]	Współrzędne punktu w pobliżu segmentu drogowego. Ten parametr jest listą czterech współrzędnych, zawierających dwie pary współrzędnych (lat, long, lat, long) i obliczane przy użyciu projekcji EPSG4326. 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 do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające mierzoną prędkość bezwzględną, względną, która zwraca szybkość względem przepływu wolnego, opóźnienie względne, 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 być w zakresie: 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ń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra 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 OAuth 2.0 Microsoft Entra. 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 Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów 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 Azure Maps interfejsów API REST.

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łówkax-ms-client-id, aby wskazać, do którego zasobu 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 Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

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

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

Scopes

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

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany 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 Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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.

Type: apiKey
In: header

Przykłady

Request traffic flow segment information

Sample Request

HTTP

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

Sample Response

Status code:: 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 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 do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające mierzoną prędkość bezwzględną, względną, która zwraca szybkość względem przepływu wolnego, opóźnienie względne, 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 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 błędu.

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ść jest miarą jakości dostarczonego 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 szybkość 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 wysokiej jakości w każdej skali.
currentSpeed	integer	Bieżąca średnia szybkość w wybranym punkcie w żądanych jednostkach. Jest to obliczane z bieżącej wartościTravelTime i długości wybranego segmentu.
currentTravelTime	integer	Bieżący czas podróży w sekundach, w tym segmencie ruchu, na podstawie bezpieczonych pomiarów czasu rzeczywistego między zdefiniowanymi lokalizacjami w określonym kierunku.
frc	string	Klasa dróg funkcjonalnych. Wskazuje to typ drogi: 0: Autostrada, autostrada, autostrada lub inna główna droga. 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 powinien być oczekiwany w idealnych warunkach swobodnego przepływu.
openlr	string	Kod OpenLR dla segmentu. Zobacz OpenLR , aby uzyskać więcej informacji na temat używania 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	Rozszerzalny język znaczników

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 do renderowania kafelka. Prawidłowe wartości są bezwzględne, które zwracają kolory odzwierciedlające mierzoną prędkość bezwzględną, względną, która zwraca szybkość względem przepływu wolnego, opóźnienie względne, 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