通过

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

Traffic - Get Traffic Incident Detail

  • 参考
服务:
Maps
API 版本:
1.0

用于获取给定边界框中交通事件的相关信息。

Traffic Incident Detail API 是一个 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}
具有可选参数: 
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、maxLon）来指定对。

注意：如果使用纬度/经度对，则必须将 projection 参数设置为“EPSG4326”。
boundingZoom
 query True

integer (int32)

minimum: 0
maximum: 22

所需磁贴的缩放级别。 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、en-GB、en-US、es、et、fi、fr、he、胡、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

这些 Microsoft Entra OAuth 2.0 流。 与 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 允许为多个用例设置基于应用程序的配置。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

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

subscription-key

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

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

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

类型: apiKey
在: query

SAS Token

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

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

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

类型: apiKey
在: header

示例

Request information about a traffic incident

示例请求

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

示例响应

状态代码:
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

主响应元素
TrafficIncidentDetail

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

DelayMagnitude

枚举

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

值 说明
0

未知
1

轻微
2

中等
3

主要
4

无限期（用于道路关闭和其他无限期延误）

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IconCategory

枚举

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

值 说明
0

未知
1

事故
10

风能
11

淹没
12

弯路
13

群集：如果群集包含具有不同图标类别的事件，则返回。
14

分解车辆
2

雾
3

危险条件
4

雨
5

Ice
6

果酱
7

通道关闭
8

道路封闭
9

道路工程

IncidentDetailStyle

枚举

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

值 说明
night

夜式。
s1

创建带有彩色 V 形的交通线路，指示严重性。
s2

创建具有特定发光度的纯线。
s3

创建具有特定程度的发光的纯线，不同于 s2 样式。

IncidentGeometryType

枚举

添加到事件的矢量几何图形的类型（在响应的元素中返回）。

值 说明
original

将事件精确放在路上。
shifted

稍微移动事件（具体取决于缩放级别），以指示特定的道路车道。

Point

Object

笛卡尔平面中坐标 （x， y） 的点的泛型表示形式。

名称 类型 说明
x

number

x 坐标
y

number

y 坐标

ProjectionStandard

枚举

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

值 说明
EPSG4326

EPSG4326
EPSG900913

EPSG900913

ResponseFormat

枚举

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

值 说明
json

JavaScript 对象表示法数据交换格式
xml

可扩展标记语言

Tm

Object

主响应元素

名称 类型 说明
@id

string

此事件的流量模型的 ID
poi

TrafficIncidentPointOfInterest[]

单个流量事件或流量事件的群集

TrafficIncidentDetail

Object

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

名称 类型 说明
tm

Tm

主响应元素

TrafficIncidentPointOfInterest

Object
名称 类型 说明
c

string

事件的原因（如果可用），采用所请求的语言
cbl

Point

请求投影中群集的左下角坐标
cs

integer (int32)

群集大小：群集中的事件数
ctr

Point

请求投影中群集的右上坐标
d

string

所请求语言的事件说明
dl

integer (int32)

事件造成的延误（道路关闭除外）
ed

string (date-time)

事件的估计结束日期（如果可用）。 日期以ISO8601格式描述。
f

string

来源：由于事件开始的交通的交集或位置的名称
ic

IconCategory (int32)

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

string

交通事件的 ID
l

integer (int32)

事件长度（以米为单位）
p

Point

应在请求的投影中绘制群集或原始事件的图标的点。 这受交通风格、缩放级别和道路类型影响
r

string

受事件影响的路号。 多个路号将用斜杠分隔
sd

string (date-time)

事件的开始日期（如果可用）。 日期以ISO8601格式描述。
t

string

To：由于事件结束而发生流量的交集或位置的名称
ty

DelayMagnitude (int32)

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