Udostępnij przez


Traffic - Get Traffic Incident

Interfejs API zdarzeń ruchu zapewnia zdarzenia ruchu, takie jak budowa, przeciążenie ruchu i wypadki itp. w polu ograniczenia. Udostępnia również metadane ruchu w celu uzyskania szczegółowych informacji o każdym zdarzeniu.

Interfejs API udostępnia kolekcję funkcji GeoJSON zdarzeń ruchu. Każde zdarzenie zawiera dwie cechy punktów: lokalizację, w której występuje zdarzenie, oraz lokalizację końcową zdarzenia drogowego, na przykład koniec strefy budowy. Aby uzyskać informacje o zdarzeniach drogowych według kraju/regionu, zobacz informacje o ruchu drogowym.

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
query True

string

Numer wersji interfejsu API usługi Azure Maps.

bbox
query True

number[]

Definiuje prostokątny obszar zainteresowania na powierzchni Ziemi. Boki prostokąta są określone przez wartości długości i szerokości geograficznej i muszą być zgodne z formatem GeoJSON: [minLon, minLat, maxLon, maxLat]. Aby uzyskać więcej informacji, zobacz RFC 7946, sekcja 5.

  • Minimalne wymiary: Wysokość lub szerokość obwiedni musi wynosić co najmniej 12 metrów.
  • Maksymalny obszar: Obwiednia może obejmować obszar do 10 000 kilometrów kwadratowych.
  • Uwzględnianie zdarzeń: Zdarzenia drogowe zostaną uwzględnione w odpowiedzi, jeśli nakładają się na obwiednię lub jeśli ich początek, koniec lub dowolna część zdarzenia przechodzi przez obwiednię. Lokalizacja początkowa i końcowa zdarzenia może znajdować się poza polem ograniczenia.
Przykład:bbox=-105,37,-94,45

incidentType
query

IncidentType

Określa typ zdarzenia ruchu, który ma zostać zwrócony. Obsługiwane są wiele typów zdarzeń w ramach jednego żądania. Jeśli nie zostanie określony, wyniki będą zawierać wszystkie typy zdarzeń w podanym polu ograniczenia.

Na przykład "&incidentType=Accident" lub "&incidentType=Accident,Construction".

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ń usługi Azure AD. 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 uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps.

Accept-Language

string

Język, w którym powinny zostać zwrócone wyniki zdarzenia ruchu.

Aby uzyskać więcej informacji, zobacz Obsługiwane języki w celach informacyjnych.

Odpowiedzi

Nazwa Typ Opis
200 OK

TrafficIncidentResponse

OK

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć 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 mogą 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 koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.

Notes

  • 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ć za pomocą interfejsu API zarządzania Maps.

Authorization URL jest specyficzna 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 na podstawie 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 Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

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 tworzenie 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 całego interfejsu 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 poufnych aplikacji klienckich podejście do uzyskiwania 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 SAS na 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 i 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 zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Request information about a traffic incident

Przykładowe żądanie

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61

Przykładowa odpowiedź

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 125193835200120000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20148,
          47.609058
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T20:50:41.3340000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Stationary traffic on Bellevue Way SE from SE 3rd St to Bellevue Way NE / Main St.",
        "severity": 1,
        "isRoadClosed": false,
        "title": "Bellevue Way SE",
        "isTrafficJam": true,
        "delay": 125,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.202707,
            47.610156
          ]
        }
      }
    },
    {
      "type": "Feature",
      "id": 125453508966320000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.195563,
          47.499877
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T19:19:00.0000000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Slow traffic on I-405 N from Sunset Blvd NE exit [5] to exit [7].",
        "severity": 1,
        "isRoadClosed": false,
        "title": "I-405 N",
        "isTrafficJam": true,
        "delay": 141,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.196893,
            47.531893
          ]
        }
      }
    }
  ]
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

FeaturesItemTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

FeatureTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

GeoJsonPoint

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

IncidentType

Określa typ zdarzenia ruchu. Może to służyć do żądania i rozróżniania różnych typów zdarzeń.

TrafficIncidentFeatureProperties

Określa szczegółowe informacje o zdarzeniach ruchu.

TrafficIncidentFeaturesItem

Określa obiekt funkcji GeoJSON zdarzenia ruchu, w tym geometrię i dodatkowe właściwości.

TrafficIncidentResponse

Obiekt kolekcji funkcji GeoJSON, który zawiera listę funkcji zdarzeń ruchu drogowego.

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.

FeaturesItemTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

Wartość Opis
Feature

Określa typ obiektu funkcji GeoJSON.

FeatureTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

Wartość Opis
FeatureCollection

Określa typ obiektu GeoJSONFeatureCollection.

GeoJsonPoint

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa Typ Opis
coordinates

number[] (double)

Position to tablica liczb z co najmniej dwoma elementami. Dwa pierwsze elementy to długości geograficznej i szerokości geograficznej, dokładnie w tej kolejności. wysokości/wysokości jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

type

string

Określa typ GeoJSON jako Punkt.

IncidentType

Określa typ zdarzenia ruchu. Może to służyć do żądania i rozróżniania różnych typów zdarzeń.

Wartość Opis
Accident

Accident

Congestion

Congestion

DisabledVehicle

DisabledVehicle

Miscellaneous

Miscellaneous

RoadHazard

RoadHazard

Construction

Construction

Weather

Weather

TrafficIncidentFeatureProperties

Określa szczegółowe informacje o zdarzeniach ruchu.

Nazwa Typ Opis
delay

number (double)

Opóźnienie spowodowane przez zdarzenie w sekundach. Jeśli nie ma opóźnienia lub nie ma zastosowania, zwraca zero.

description

string

Opis zdarzenia, który zawiera nazwę drogi i zdarzenie wpływające na przepływ ruchu.

Examples:

• W 95 st między Switzer Rd i Bluejacket Dr - budowa

• WB Johnson Dr w I-435 - naprawa mostu

endPoint

object

Obiekt GeoJson Point, który określił lokalizację końcową zdarzenia ruchu, takiego jak koniec strefy budowy.

Ta lokalizacja jest częścią obiektu właściwości zdarzenia i domyślnie nie może być interpretowana przez analizatory do wyświetlania na mapie.

endTime

string

Data i godzina w formacie UTC zakończenia zdarzenia ruchu, sformatowana jako wartość dateTime zdefiniowana w RFC 3339, sekcja 5.6.

incidentType

IncidentType

Określa typ zdarzenia ruchu. Może to służyć do żądania i rozróżniania różnych typów zdarzeń.

isRoadClosed

boolean

Wartość true wskazuje, że jest zamknięcie drogi.

isTrafficJam

boolean

Wartość true wskazuje, że obszar drogi objętej tym incydentem ma nietypowe warunki ruchu, co powoduje nietypowe opóźnienia.

lastModifiedTime

string

Data i godzina w formacie UTC ostatniej aktualizacji informacji o zdarzeniu, sformatowana jako wartość dateTime zdefiniowana w RFC 3339, sekcja 5.6.

severity

integer (int32)

Określa poziom ważności zdarzenia.

  • 0: Nieznany

  • 1: Mniejszy

  • 2: Umiarkowany

  • 3: Główny

  • 4: Niezdefiniowany (używany do zamknięć dróg i innych opóźnień na czas nieokreślony)

startTime

string

Data i godzina w formacie UTC, kiedy wystąpiło zdarzenie, sformatowane jako wartość dateTime zgodnie z definicją w RFC 3339, sekcja 5.6.

title

string

Określa nazwy dróg i kierunek dotkniętych dróg.

TrafficIncidentFeaturesItem

Określa obiekt funkcji GeoJSON zdarzenia ruchu, w tym geometrię i dodatkowe właściwości.

Nazwa Typ Opis
geometry

GeoJsonPoint

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

id

integer (int64)

Unikatowy identyfikator zdarzenia.

properties

TrafficIncidentFeatureProperties

Określa szczegółowe informacje o zdarzeniach ruchu.

type

FeaturesItemTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

TrafficIncidentResponse

Obiekt kolekcji funkcji GeoJSON, który zawiera listę funkcji zdarzeń ruchu drogowego.

Nazwa Typ Opis
features

TrafficIncidentFeaturesItem[]

GeoJSON obiekt funkcji, który zawiera obiekt Geometry i dodatkowe właściwości. Aby uzyskać szczegółowe informacje, zobacz RFC 7946, sekcja 3.2.

type

FeatureTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.