你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Traffic - Get Traffic Incident Viewport
使用 获取视区的法律和技术信息。
Traffic Incident Viewport
API 是一个 HTTP GET
请求,它返回请求中所述的视区的法律和技术信息。 每当视区 (更改时,客户端应用程序应调用它,例如,通过缩放、平移、转到某个位置或显示) 路由。 请求应包含需要其信息的视区边界框和缩放级别。 返回内容将包含地图版本信息,以及当前的流量模型 ID 和版权 ID。 其他 API 使用视区说明返回的流量模型 ID 来检索最后的流量信息,以便进一步处理。
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}©right={copyright}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
boundingbox
|
query | True |
number[] |
投影中地图视区边界框 EPSG900913 。
|
boundingzoom
|
query | True |
integer int32 |
地图视区缩放级别。 用于确定是否可以放大视图。 |
overviewbox
|
query | True |
number[] |
EPSG900913投影中概述地图的边界框。 |
overviewzoom
|
query | True |
integer int32 |
概述地图的缩放级别。 如果没有小型地图,请使用与 boundingZoom 相同的缩放级别。 |
copyright
|
query |
boolean |
确定要返回哪些版权信息。 如果为 true,则返回版权文本;如果为 false,则仅返回版权索引。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定要与 Microsoft Entra ID 安全模型一起使用的帐户。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
发生了意外错误。 |
安全性
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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 映射帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Request traffic incident information for the selected viewport
示例请求
GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2©right=True
示例响应
{
"viewpResp": {
"trafficState": {
"@trafficAge": 18895,
"@trafficModelId": "1504808593298"
},
"copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis",
"@version": "1.0.51-mascoma",
"@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
}
}
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Response |
响应的所需格式。 值可以是 json 或 xml。 |
Traffic |
此对象是从成功的交通事件视区调用返回的 |
Traffic |
流量状态信息 |
Viewp |
视区响应对象 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
ResponseFormat
响应的所需格式。 值可以是 json 或 xml。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
|
xml |
string |
TrafficIncidentViewport
此对象是从成功的交通事件视区调用返回的
名称 | 类型 | 说明 |
---|---|---|
viewpResp |
视区响应对象 |
TrafficState
流量状态信息
名称 | 类型 | 说明 |
---|---|---|
@trafficAge |
integer |
从创建流量模型 ID) ,已用时间 (以秒为单位。 |
@trafficModelId |
string |
调用交通事件服务时,将使用名为“流量模型 ID”的唯一 ID。 它允许从特定流量更新获取信息。 流量模型 ID 每分钟更新一次,在超时前有效期为两分钟。 |
ViewpResp
视区响应对象
名称 | 类型 | 说明 |
---|---|---|
@maps |
string |
指示视区中使用的地图数据的数据提供程序的内部名称。 用于支持查询。 |
@version |
string |
指示用于生成信息的软件版本。 用于支持查询。 |
copyrightIds |
string |
如果版权参数值为 true,则包含必须使用视区中的磁贴显示的版权信息的全文 |
trafficState |
流量状态信息 |