Traffic - Get Traffic Incident
A API de Incidentes de Tráfego fornece incidentes de trânsito como construção, congestionamento de tráfego e acidentes, etc. dentro de uma caixa delimitadora. Também fornece metadados de tráfego para obter informações detalhadas sobre cada incidente.
A API fornece uma coleção de recursos GeoJSON de incidentes de tráfego. Cada incidente inclui duas características pontuais: o local onde você encontra o incidente e o local final de um incidente de trânsito, como o final de uma zona de construção. Para cobertura de incidentes de trânsito por país/região, consulte Cobertura de tráfego.
GET {endpoint}/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET {endpoint}/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
|
bbox
|
query | True |
number[] |
Define uma área retangular de interesse na superfície da Terra. Os lados do retângulo são especificados por valores de longitude e latitude e devem aderir ao formato GeoJSON: [minLon, minLat, maxLon, maxLat]. Para obter mais informações, consulte RFC 7946, Seção 5.
|
|
incident
|
query |
Especifica o tipo de incidente de tráfego a ser retornado. Vários tipos de incidentes em uma única solicitação são suportados. Se não for especificado, os resultados incluirão todos os tipos de incidentes dentro da caixa delimitadora fornecida. Exemplo, '&incidentType=Accident' ou '&incidentType=Accident,Construction'. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual a conta destinada a ser usada em conjunto com o modelo de segurança do Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado na API de Contas do plano de gestão do Azure Maps. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps. |
|
| Accept-Language |
string |
Língua em que os resultados dos incidentes de trânsito devem ser devolvidos. Para obter mais informações, consulte Idiomas suportados para referência. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
AadToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para Azure Maps APIs REST.\n\nPara implementar cenários, recomendamos consultar conceitos autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações(ões) através de objetos capazes de controlo de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isto pode ser adquirido da API de gestão Maps.\n* \nO Authorization URL é específico para a instância Azure cloud pública. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controlo de acesso Azure baseado em funções é configurado a partir do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUtilização do Azure Maps Web SDK permite a configuração de uma aplicação para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft visão geral.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é provisionada quando Cria uma conta Azure Maps no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com esta chave, qualquer aplicação pode aceder a toda a API REST. Ou seja, esta chave pode ser usada como chave mestra na conta onde são emitidas.\n\n Para aplicações expostas publicamente, a nossa recomendação é usar a abordagem confidenciais de aplicações cliente para aceder às APIs REST Azure Maps para que a sua chave possa ser armazenada de forma segura.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicação está autorizada a aceder com Azure controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização para o token em questão. Por outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave partilhada.\n\n Para aplicações publicamente expostas, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos de renderização e renovar regularmente o Token SAS.
Tipo:
apiKey
Em:
header
Exemplos
Request information about a traffic incident
Pedido de amostra
GET {endpoint}/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61
Resposta da amostra
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20148,
47.609058
]
},
"id": 125193835200120000,
"properties": {
"description": "Stationary traffic on Bellevue Way SE from SE 3rd St to Bellevue Way NE / Main St.",
"delay": 125,
"endPoint": {
"type": "Point",
"coordinates": [
-122.202707,
47.610156
]
},
"endTime": "2025-05-01T20:50:41.3340000Z",
"incidentType": "Congestion",
"isRoadClosed": false,
"isTrafficJam": true,
"lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
"severity": 1,
"startTime": "2025-05-01T18:47:00.0000000Z",
"title": "Bellevue Way SE"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.195563,
47.499877
]
},
"id": 125453508966320000,
"properties": {
"description": "Slow traffic on I-405 N from Sunset Blvd NE exit [5] to exit [7].",
"delay": 141,
"endPoint": {
"type": "Point",
"coordinates": [
-122.196893,
47.531893
]
},
"endTime": "2025-05-01T19:19:00.0000000Z",
"incidentType": "Congestion",
"isRoadClosed": false,
"isTrafficJam": true,
"lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
"severity": 1,
"startTime": "2025-05-01T18:47:00.0000000Z",
"title": "I-405 N"
}
}
]
}
Definições
| Name | Description |
|---|---|
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.) |
|
Features |
Especifica o tipo de |
|
Feature |
Especifica o tipo de |
|
Geo |
Especifica o tipo de |
|
Geo |
Um tipo de geometria |
|
Incident |
Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes. |
|
Traffic |
Especifica informações detalhadas sobre os incidentes de trânsito. |
|
Traffic |
Objeto de característica GeoJSON que contém o objeto Geometria e propriedades adicionais dos incidentes de tráfego. |
|
Traffic |
Um objeto de coleção de recursos GeoJSON que contém uma lista de recursos de incidentes de tráfego. |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
| Name | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
FeaturesItemTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica o tipo de objeto |
FeatureTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| FeatureCollection |
Especifica o tipo de objeto |
GeoJsonObjectType
Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.
| Valor | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
IncidentType
Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes.
| Valor | Description |
|---|---|
| Accident |
Acidente |
| Congestion |
Congestion |
| DisabledVehicle |
DisabledVehicle |
| Miscellaneous |
Miscellaneous |
| RoadHazard |
RoadHazard |
| Construction |
Construção |
| Weather |
Meteorologia |
TrafficIncidentFeatureProperties
Especifica informações detalhadas sobre os incidentes de trânsito.
| Name | Tipo | Description |
|---|---|---|
| delay |
number (double) |
O atraso causado pelo incidente em segundos. Se não houver atraso ou não for aplicável, ele retornará zero. |
| description |
string |
Uma descrição do incidente que inclui o nome da estrada e o evento que afeta o fluxo de tráfego. Exemplos: • W 95th St entre Switzer Rd e Bluejacket Dr - construção • WB Johnson Dr na I-435 - reparação de pontes |
| endPoint |
Um objeto GeoJson Point que especificou o local final de um incidente de tráfego, como o fim de uma zona de construção. Esse local faz parte do objeto de propriedades do incidente e, por padrão, não pode ser interpretado por analisadores para exibição no mapa. |
|
| endTime |
string |
A data e hora em UTC quando o incidente de trânsito terminará, formatado como um valor dateTime, conforme definido no RFC 3339, seção 5.6. |
| incidentType |
Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes. |
|
| isRoadClosed |
boolean |
Um valor de |
| isTrafficJam |
boolean |
Um valor de |
| lastModifiedTime |
string |
A data e a hora em UTC em que as informações do incidente foram atualizadas pela última vez, formatadas como um valor dateTime, conforme definido no RFC 3339, seção 5.6. |
| severity |
integer (int32) |
Especifica o nível de importância do incidente.
|
| startTime |
string |
A data e hora em UTC quando o incidente ocorreu, formatado como um valor dateTime, conforme definido no RFC 3339, seção 5.6. |
| title |
string |
Especifica os nomes das estradas e a direção das estradas afetadas. |
TrafficIncidentFeaturesItem
Objeto de característica GeoJSON que contém o objeto Geometria e propriedades adicionais dos incidentes de tráfego.
| Name | Tipo | Description |
|---|---|---|
| geometry |
Um tipo de geometria |
|
| id |
integer (int64) |
Um ID exclusivo para o incidente. |
| properties |
Especifica informações detalhadas sobre os incidentes de trânsito. |
|
| type |
Especifica o tipo de |
TrafficIncidentResponse
Um objeto de coleção de recursos GeoJSON que contém uma lista de recursos de incidentes de tráfego.
| Name | Tipo | Description |
|---|---|---|
| features |
|
|
| type |
Especifica o tipo de |