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

Traffic - Get Traffic Incident Tile

Service:

Maps

API Version:

1.0

使用 获取显示交通事件的 256 x 256 像素磁贴。

API Traffic Incident Tile 是一个 HTTP GET 请求，返回显示交通事件的 256 x 256 像素磁贴。 所有磁贴都使用相同的网格系统。 由于交通图块使用透明图像，因此可以在地图图块顶部分层以创建复合显示。 交通磁贴呈现图形以指示指定区域中道路的交通状况。

GET https://atlas.microsoft.com/traffic/incident/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}&t={t}

URI 参数

名称	在	必需	类型	说明
format	path	True	TileFormat	响应的所需格式。 可能的值为 png & pbf。
api-version	query	True	string	Azure Maps API 的版本号。
style	query	True	TrafficIncidentTileStyle	用于呈现磁贴的样式。 当格式为 pbf 时，此参数无效。
x	query	True	integer int32	缩放网格上磁贴的 X 坐标。 值必须在 [0， 2zoom -1] 范围内。 有关详细信息 ，请参阅缩放级别和磁贴网格 。
y	query	True	integer int32	缩放网格上磁贴的 Y 坐标。 值必须在 [0， 2zoom -1] 范围内。 有关详细信息 ，请参阅缩放级别和磁贴网格 。
zoom	query	True	integer int32	所需磁贴的缩放级别。 对于 光栅 图块，值必须在以下范围内：0-22 (包含) 。 对于 矢量 平铺，值必须在以下范围内：0-22 (包含) 。 有关详细信息 ，请参阅缩放级别和磁贴网格 。
t	query		string	特定时间流量状态的参考值，从视区 API 调用获取，trafficState 字段中的 trafficModelId 属性。 它每分钟更新一次，有效期为两分钟，然后才超时。使用 -1 获取最新的交通信息。 默认值：最新的交通信息。

请求头

名称	必需	类型	说明
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" Headers Content-Type: string
Other Status Codes	ErrorResponse	发生了意外错误。 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 标识平台概述。

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 a tile depicting a traffic incident

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/incident/tile/png?api-version=1.0&style=night&zoom=10&x=175&y=408

Sample Response

Status code:

200

{}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
TileFormat	响应的所需格式。 可能的值为 png & pbf。
TrafficIncidentTileStyle	用于呈现磁贴的样式。 当格式为 pbf 时，此参数无效。

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

TileFormat

响应的所需格式。 可能的值为 png & pbf。

名称	类型	说明
pbf	string	pbf 格式的矢量图形。 支持缩放级别 0 到 22。
png	string	png 格式的图像。 支持缩放级别 0 到 18。

TrafficIncidentTileStyle

用于呈现磁贴的样式。 当格式为 pbf 时，此参数无效。

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