你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Traffic - Get Traffic Incident Detail

参考

Service:: Maps

API Version:: 1.0

用于获取给定边界框内交通事故的信息。

API Traffic Incident Detail 是一个 HTTP GET 请求，它基于当前流量模型 ID，提供有关给定边界框中的交通事件的信息。流量模型 ID 可用于授予调用与 API 之间的数据同步。交通模型 ID 是用于确定交通事件货币的键值。它每分钟更新一次，有效期为两分钟，然后才超时。它用于呈现事件磁贴。可以从视区 API 获取它。

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}&language={language}&projection={projection}&geometries={geometries}&expandCluster={expandCluster}&originalPosition={originalPosition}

URI 参数

名称	在	必需	类型	说明
format	path	True	ResponseFormat	响应的所需格式。值可以是 json 或 xml。
api-version	query	True	string	Azure Maps API 的版本号。
boundingbox	query	True	number[]	`boundingbox`由两个值对表示，分别描述其角 (左下角的第一对，第二对表示右上角) 。可以使用以下任何 `projection`指定的 (（例如 minY，minX，maxY，maxX) ）或两个纬度-经度对 (指定对，例如 minLat，minLon，maxLat，maxLat，maxLon) 。注意：如果使用纬度/经度对，则必须将 `projection` 参数设置为“EPSG4326”。
boundingZoom	query	True	integer int32	所需磁贴的缩放级别。光栅图块为 0 到 22，矢量图块为 0 到 22
style	query	True	IncidentDetailStyle	用于在交通事件磁贴 API 中呈现磁贴的样式。这将影响回复中交通事件的坐标。
trafficmodelid	query	True	string	引用流量模型的数字。这可以从视区 API 获取。它每分钟更新一次，有效期为两分钟，然后才超时。如果指定了错误的流量模型 ID，接口将返回正确的流量模型 ID。值 -1 将始终调用最新的流量模型
expandCluster	query		boolean	布尔值，指示是否单独列出群集中的所有交通事件
geometries	query		IncidentGeometryType	添加到事件 (响应) 元素中返回的矢量几何图形的类型。
language	query		string	输出语言的 ISO 639-1 代码。支持的语言包括 ar、ca、cs、da、de、el、en-GB、en-GB、en-US、es、et、fi、fr、he、hu、id、in*、it、lt、lv、nb、nl、no、pl、pt、ro、ru、sk、sv、th、tr、zh。有关详细信息，请参阅支持的语言。当提供无效的语言代码时，响应以英语返回。当事件原因或说明没有翻译时，将返回英文说明。
originalPosition	query		boolean	布尔值是否返回事件的原始位置 () 以及转移到交通管的开头 ()
projection	query		ProjectionStandard	用于指定请求和响应中的坐标的投影。 EPSG900913 (默认) 或 EPSG4326

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定要与Microsoft Entra ID安全模型一起使用的帐户。它表示Azure Maps帐户的唯一 ID，可以从Azure Maps管理平面帐户 API 检索。若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	TrafficIncidentDetail	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

AADToken

这些是 OAuth 2.0 流Microsoft Entra。与 Azure 基于角色的访问控制配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限，以Azure Maps REST API。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问哪个Azure Maps资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和Microsoft Entra ID配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

有关Microsoft 标识平台的详细信息，请参阅Microsoft 标识平台概述。

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

Scopes

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户中使用 PowerShell、CLI、Azure SDK 或 REST API Create Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

这是一个共享访问签名令牌，通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API，通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

Type: apiKey
In: header

示例

Request information about a traffic incident

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/incident/detail/json?api-version=1.0&style=s3&boundingbox=6841263.950712,511972.674418,6886056.049288,582676.925582&boundingZoom=11&trafficmodelid=1335294634919

Sample Response

Status code:: 200

{
  "tm": {
    "@id": "1521671948910",
    "poi": [
      {
        "id": "europe_HD_NL_TTR116377227776064",
        "p": {
          "x": 538636.9,
          "y": 6842004.5
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Amstelveen/Vinkeveen - N201 (N196)",
        "t": "Uithoorn-Centrum (N196)",
        "l": 220,
        "dl": 14,
        "r": "N196"
      },
      {
        "id": "europe_CLUSTER_11_-34959639",
        "p": {
          "x": 528668.6,
          "y": 6848897.9
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 528622.5,
          "y": 6848661.2
        },
        "ctr": {
          "x": 528714.7,
          "y": 6849134.6
        },
        "cs": 2,
        "l": 190
      },
      {
        "id": "europe_CLUSTER_11_-1540737434",
        "p": {
          "x": 518277,
          "y": 6852206.8
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 517421.3,
          "y": 6851776.4
        },
        "ctr": {
          "x": 519132.8,
          "y": 6852637.2
        },
        "cs": 2,
        "l": 1620
      },
      {
        "id": "europe_CLUSTER_11_-26712906",
        "p": {
          "x": 529902.2,
          "y": 6855622.4
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 529524.6,
          "y": 6855377.2
        },
        "ctr": {
          "x": 530279.9,
          "y": 6855867.7
        },
        "cs": 4,
        "l": 660
      },
      {
        "id": "europe_HD_NL_TTR116367997504816",
        "p": {
          "x": 568216,
          "y": 6851287.6
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Ankeveen (N236)",
        "t": "Weesp (N236)",
        "l": 2760,
        "dl": 73,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116367997261488",
        "p": {
          "x": 561973.7,
          "y": 6854259.4
        },
        "ic": 9,
        "ty": 3,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Weesp (N236)",
        "t": "Ankeveen (N236)",
        "l": 2650,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116331064819392",
        "p": {
          "x": 571268.5,
          "y": 6858435.4
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "IJsselmeerweg",
        "t": "A6",
        "l": 370
      },
      {
        "id": "europe_CLUSTER_11_-1442937814",
        "p": {
          "x": 563934,
          "y": 6859271.3
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 563726.1,
          "y": 6859250.4
        },
        "ctr": {
          "x": 564141.9,
          "y": 6859292.2
        },
        "cs": 2,
        "l": 460
      },
      {
        "id": "europe_CLUSTER_11_258400781",
        "p": {
          "x": 558055.6,
          "y": 6861147.1
        },
        "ic": 13,
        "ty": 1,
        "cbl": {
          "x": 557493.3,
          "y": 6860514.8
        },
        "ctr": {
          "x": 558618,
          "y": 6861779.4
        },
        "cs": 3,
        "l": 1030
      },
      {
        "id": "europe_HD_NL_TTR116100227865681",
        "p": {
          "x": 542665,
          "y": 6861959.7
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Strawinskylaan",
        "t": "Matthijs Vermeulenpad",
        "l": 110
      },
      {
        "id": "europe_CLUSTER_11_1438243625",
        "p": {
          "x": 545058.7,
          "y": 6864571.6
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543779.5,
          "y": 6864070.7
        },
        "ctr": {
          "x": 546337.8,
          "y": 6865072.6
        },
        "cs": 5,
        "l": 1590
      },
      {
        "id": "europe_HD_NL_TTR116081762316976",
        "p": {
          "x": 547507.8,
          "y": 6866259.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Alexanderplein (s113)",
        "t": "Stadhouderskade",
        "l": 390,
        "r": "S100"
      },
      {
        "id": "europe_CLUSTER_11_691732516",
        "p": {
          "x": 541448.7,
          "y": 6867162.1
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 541160.1,
          "y": 6866710.7
        },
        "ctr": {
          "x": 541737.2,
          "y": 6867613.5
        },
        "cs": 4,
        "l": 430
      },
      {
        "id": "europe_CLUSTER_11_1582351486",
        "p": {
          "x": 534709.6,
          "y": 6865174.7
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 534562.2,
          "y": 6865025.3
        },
        "ctr": {
          "x": 534856.9,
          "y": 6865324.2
        },
        "cs": 2,
        "l": 380
      },
      {
        "id": "europe_CLUSTER_11_-2070222267",
        "p": {
          "x": 536813.1,
          "y": 6868188.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 536191.1,
          "y": 6867699.7
        },
        "ctr": {
          "x": 537435.1,
          "y": 6868677
        },
        "cs": 7,
        "l": 1380
      },
      {
        "id": "europe_CLUSTER_11_-496866890",
        "p": {
          "x": 516025.5,
          "y": 6871606.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 514115.1,
          "y": 6870216.9
        },
        "ctr": {
          "x": 517935.9,
          "y": 6872995.7
        },
        "cs": 7,
        "l": 1510
      },
      {
        "id": "europe_HD_NL_TTR115675492352160",
        "p": {
          "x": 517835.3,
          "y": 6883216.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Amsterdamseweg",
        "t": "A22",
        "l": 710
      },
      {
        "id": "europe_CLUSTER_11_834920993",
        "p": {
          "x": 543803.8,
          "y": 6875659.8
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543474.7,
          "y": 6875602.7
        },
        "ctr": {
          "x": 544133,
          "y": 6875716.9
        },
        "cs": 2,
        "l": 760
      }
    ]
  }
}

定义

名称	说明
DelayMagnitude	与事件相关的延迟幅度。这些值对应于交通磁贴中的事件颜色
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
IconCategory	与此事件关联的图标类别。值是 0-13 范围内的数字，具有以下含义 -- 0：未知，1：事故，2：雾，3：危险条件，4：雨，5：冰，6：果酱，7：车道封闭，8：道路封闭，9：道路工程，10：风，11：洪水，12：绕道，13：群集
IncidentDetailStyle	用于在交通事件磁贴 API 中呈现磁贴的样式。这将对答复中交通事件的坐标产生影响。
IncidentGeometryType	添加到事件 (响应) 元素中返回的向量几何图形的类型。
Point	在笛卡尔平面中具有 (x、y) 坐标的点的泛型表示形式。
ProjectionStandard	用于指定请求和响应中的坐标的投影。 EPSG900913 (默认) 或 EPSG4326
ResponseFormat	响应的所需格式。值可以是 json 或 xml。
Tm	Main response 元素
TrafficIncidentDetail	此对象是从成功的交通事件详细信息调用返回的
TrafficIncidentPointOfInterest

DelayMagnitude

与事件相关的延迟幅度。这些值对应于交通磁贴中的事件颜色

名称	类型	说明
0	Integer	未知
1	Integer	次要
2	Integer	中等
3	Integer	主要
4	Integer	无限期 (用于道路封闭和其他无限期延误)

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IconCategory

与此事件关联的图标类别。值是 0-13 范围内的数字，具有以下含义 -- 0：未知，1：事故，2：雾，3：危险条件，4：雨，5：冰，6：果酱，7：车道封闭，8：道路封闭，9：道路工程，10：风，11：洪水，12：绕道，13：群集

名称	类型	说明
0	Integer	未知
1	Integer	意外
10	Integer	Wind
11	Integer	淹没
12	Integer	弯路
13	Integer	群集：如果群集包含具有不同图标类别的事件，则返回。
14	Integer	分解的车辆
2	Integer	雾
3	Integer	危险条件
4	Integer	雨
5	Integer	Ice
6	Integer	果酱
7	Integer	Lane Closed
8	Integer	道路封闭
9	Integer	道路工程

IncidentDetailStyle

用于在交通事件磁贴 API 中呈现磁贴的样式。这将对答复中交通事件的坐标产生影响。

名称	类型	说明
night	string	夜间样式。
s1	string	使用指示严重性的彩色 V 形创建交通线。
s2	string	创建具有一定发光程度的纯线。
s3	string	创建具有一定程度的发光的普通线条，与 s2 样式不同。

IncidentGeometryType

添加到事件 (响应) 元素中返回的向量几何图形的类型。

名称	类型	说明
original	string	Places事件正是在路上发生的。
shifted	string	根据缩放级别) 稍微 (移动事件，以指示特定的道路车道。

Point

在笛卡尔平面中具有 (x、y) 坐标的点的泛型表示形式。

名称	类型	说明
x	number	x 坐标
y	number	y 坐标

ProjectionStandard

用于指定请求和响应中的坐标的投影。 EPSG900913 (默认) 或 EPSG4326

名称	类型	说明
EPSG4326	string	EPSG4326
EPSG900913	string	EPSG900913

ResponseFormat

响应的所需格式。值可以是 json 或 xml。

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式
xml	string	可扩展标记语言

Tm

Main response 元素

名称	类型	说明
@id	string	此事件的流量模型的 ID
poi	TrafficIncidentPointOfInterest[]	单个交通事件或一组交通事件

TrafficIncidentDetail

此对象是从成功的交通事件详细信息调用返回的

名称	类型	说明
tm	Tm	Main response 元素

TrafficIncidentPointOfInterest

名称	类型	说明
c	string	事件原因（如果可用）以请求的语言显示
cbl	Point	请求投影中群集的左下角坐标
cs	integer	群集大小：群集中的事件数
ctr	Point	请求投影中群集的右上坐标
d	string	以所请求的语言描述事件
dl	integer	事故造成的延迟（以秒为单位 (除外，道路封闭)
ed	string	事件的估计结束日期（如果可用）。日期以ISO8601格式描述。
f	string	发件人：由于事件导致的交通开始的交叉路口或位置的名称
ic	IconCategory	与此事件关联的图标类别。值是 0-13 范围内的数字，具有以下含义 -- 0：未知，1：事故，2：雾，3：危险条件，4：雨，5：冰，6：果酱，7：车道封闭，8：道路封闭，9：道路工程，10：风，11：洪水，12：绕道，13：群集
id	string	交通事件的 ID
l	integer	事件长度（以米为单位）
p	Point	应绘制群集或原始事件的图标的点，用请求的投影表示。这受交通样式、缩放级别和道路类型的影响
r	string	受事件影响的路号 () 。多个道路编号将用斜杠分隔
sd	string	事件的开始日期（如果可用）。日期以ISO8601格式描述。
t	string	To：由于事件导致的交通结束的交叉路口或位置的名称
ty	DelayMagnitude	与事件相关的延迟幅度。这些值对应于交通磁贴中的事件颜色