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

Traffic - Get Traffic Flow Segment

参考

Service:: Maps

API Version:: 1.0

用于获取有关指定路段的速度和行驶时间的信息。

API Traffic Flow Segment 是一个 HTTP GET 请求，提供有关最接近给定坐标的道路片段的速度和行驶时间的信息。它旨在与呈现服务的流层一起工作，以支持可单击的流数据可视化效果。 Traffic Flow Segment使用 API，客户端可以将地图中的任意位置与最近道路的流量数据连接起来，并将其呈现给用户。

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}

URI 参数

名称	在	必需	类型	说明
format	path	True	ResponseFormat	响应的所需格式。值可以是 json 或 xml。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	靠近路段的点的坐标。此参数是包含四个坐标的列表，其中包含两个坐标对， (纬度、长、拉) ，并使用EPSG4326投影进行计算。直接调用此终结点时，坐标将作为包含四个坐标的单个字符串传入，以逗号分隔。
style	query	True	TrafficFlowSegmentStyle	用于呈现磁贴的样式。有效值为绝对值，返回反映测量的绝对速度的颜色;相对值返回相对于自由流动的速度;相对延迟，仅当相对速度与自由流动速度不同时才显示相对速度
zoom	query	True	integer int32	所需磁贴的缩放级别。缩放值必须在以下范围内：0-22 (包含) 。有关详细信息，请参阅缩放级别和磁贴网格。
openLr	query		boolean	响应是否应包含 OpenLR 代码的布尔值
thickness	query		integer int32	表示流量的线条宽度的值。此值是一个乘数，接受的值范围为 1 - 20。默认值为 10。
unit	query		SpeedUnit	KMPH 或 MPH 中的速度单位

请求头

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

响应

名称	类型	说明
200 OK	TrafficFlowSegmentData	确定
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 允许针对多个用例对应用程序进行基于配置的设置。

有关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 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"
  }
}

定义

名称	说明
Coordinates	包括描述线段形状的坐标。坐标根据缩放级别从道路移动，以支持每个比例中的高质量可视化效果。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
FlowSegmentData	流段数据属性
LatLongPair	表示为纬度和经度的位置。
ResponseFormat	响应的所需格式。值可以是 json 或 xml。
SpeedUnit	KMPH 或 MPH 中的速度单位
TrafficFlowSegmentData	此对象是从成功的流量流段调用返回的
TrafficFlowSegmentStyle	用于呈现磁贴的样式。有效值为绝对值，返回反映测量的绝对速度的颜色;相对值返回相对于自由流动的速度;相对延迟，仅当相对速度与自由流动速度不同时才显示相对速度

Coordinates

包括描述线段形状的坐标。坐标根据缩放级别从道路移动，以支持每个比例中的高质量可视化效果。

名称	类型	说明
coordinate	LatLongPair[]	坐标数组

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

FlowSegmentData

流段数据属性

名称	类型	说明
@version	string	这表示生成响应的软件版本。
confidence	number	置信度是衡量所提供行程时间和速度的质量的指标。值 1 表示完全置信度，即响应包含最高质量的数据。较低的值表示响应可能与道路上的实际情况不同程度。任何大于 0.6 的值都表示信息基于实时探测输入。值为 0.5 表示报告的速度基于历史信息。介于 0.5 和 0.6 之间的值具有历史速度与实时速度之间的计算加权平均值。
coordinates	Coordinates	包括描述线段形状的坐标。坐标根据缩放级别从道路移动，以支持每个比例中的高质量可视化效果。
currentSpeed	integer	所选点的当前平均速度（以请求的单位为单位）。这是根据 currentTravelTime 和所选段的长度计算得出的。
currentTravelTime	integer	基于指定方向上所定义位置之间的融合实时度量值，跨此交通段的当前行程时间（以秒为单位）。
frc	string	Functional Road 类。这表示道路类型：0：高速公路、高速公路或其他主要道路。 1：主要道路，不如高速公路重要。 2：其他主要道路。 3：二级道路。 4：当地连接道路。 5：重要的地方道路。 6：当地道路。
freeFlowSpeed	integer	理想条件下预期的自由流动速度，以请求的单位表示。这与 freeFlowTravelTime 相关。
freeFlowTravelTime	integer	此交通段的行程时间（以秒为单位），在理想的自由流动条件下预期。
openlr	string	段的 OpenLR 代码。有关使用 Open LR 代码的详细信息，请参阅 OpenLR。

LatLongPair

表示为纬度和经度的位置。

名称	类型	说明
latitude	number	Latitude 属性
longitude	number	Longitude 属性

ResponseFormat

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

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

SpeedUnit

KMPH 或 MPH 中的速度单位

名称	类型	说明
KMPH	string	公里/小时
MPH	string	英里/小时

TrafficFlowSegmentData

此对象是从成功的流量流段调用返回的

名称	类型	说明
flowSegmentData	FlowSegmentData	流段数据属性

TrafficFlowSegmentStyle

用于呈现磁贴的样式。有效值为绝对值，返回反映测量的绝对速度的颜色;相对值返回相对于自由流动的速度;相对延迟，仅当相对速度与自由流动速度不同时才显示相对速度

名称	类型	说明
absolute	string
relative	string
relative-delay	string