你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Traffic - Get Traffic Flow Tile
使用 获取显示流量流的 256 x 256 像素磁贴。
API Traffic Flow Tile
是一个 HTTP GET
请求,它以显示流量流的 256 x 256 像素磁贴返回有关交通状况的实时信息。 所有磁贴都使用相同的网格系统。 由于交通图块使用透明图像,因此可以在地图图块顶部分层以创建复合显示。 Flow 磁贴使用颜色来指示不同路段上的交通速度,或该车速与有关路段上的自由流动速度之间的差异。
GET https://atlas.microsoft.com/traffic/flow/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/traffic/flow/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}&thickness={thickness}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 可能的值为 png & pbf。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
style
|
query | True |
用于呈现磁贴的样式。 |
|
x
|
query | True |
integer int32 |
缩放网格上磁贴的 X 坐标。 值必须在 [0, 2 有关详细信息 ,请参阅缩放级别和磁贴网格 。 |
y
|
query | True |
integer int32 |
缩放网格上磁贴的 Y 坐标。 值必须在 [0, 2 有关详细信息 ,请参阅缩放级别和磁贴网格 。 |
zoom
|
query | True |
integer int32 |
所需磁贴的缩放级别。 对于 光栅 图块,值必须在以下范围内:0-22 (包含) 。 对于 矢量 平铺,值必须在以下范围内:0-22 (包含) 。 有关详细信息 ,请参阅缩放级别和磁贴网格 。 |
thickness
|
query |
integer int32 |
表示流量的线条宽度的值。 此值是乘数,接受的值范围为 1 - 20。 默认值为 10。 当格式为 pbf 时,此参数无效。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。 它表示 Azure Maps 帐户的唯一 ID,可从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
object |
此图像是从成功的流量流磁贴调用返回的 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" 标头 Content-Type: string |
Other Status Codes |
发生了意外错误。 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
安全性
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标识平台概述。
类型:
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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 Map 帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Request tile depicting the traffic flow
示例请求
GET https://atlas.microsoft.com/traffic/flow/tile/png?api-version=1.0&style=absolute&zoom=12&x=2044&y=1360
示例响应
"binary string image"
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Tile |
响应的所需格式。 可能的值为 png & pbf。 |
Traffic |
用于呈现磁贴的样式。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
TileFormat
响应的所需格式。 可能的值为 png & pbf。
名称 | 类型 | 说明 |
---|---|---|
pbf |
string |
pbf 格式的矢量图形。 支持缩放级别 0 到 22。 |
png |
string |
png 格式的图像。 支持缩放级别 0 到 18。 |
TrafficFlowTileStyle
用于呈现磁贴的样式。
名称 | 类型 | 说明 |
---|---|---|
absolute |
string |
颜色将反映测量的绝对速度。 绝对速度是访问全速的能力。 |
reduced-sensitivity |
string |
显示相对颜色,但段需要与自由流更大的差异才能更改颜色。 此模式仅在格式为 png 时有效。 |
relative |
string |
这是相对于自由流量的速度,突出显示了交通流量可视化的拥堵区域。 自由流动是指没有拥堵且流量可以遵循限速的条件。 用于在地图上可视化交通流的最常用的选项。 |
relative-delay |
string |
仅显示与自由流动速度不同的相对颜色。 此选项将仅突出显示拥堵区域。 |