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

Traffic - Get Traffic Incident Viewport

参考

Service:: Maps

API Version:: 1.0

使用获取视区的法律和技术信息。

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}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

URI 参数

名称	在	必需	类型	说明
format	path	True	ResponseFormat	响应的所需格式。值可以是 json 或 xml。
api-version	query	True	string	Azure Maps API 的版本号。
boundingbox	query	True	number[]	投影中地图视区边界框 EPSG900913 。 `boundingbox`由两个值对表示，描述其角 (左下角的第一对，第二对表示右上角) 。直接调用此终结点时，所有值都应用逗号分隔 (例如 minY、minX、maxY、maxX) 。可传递的边界框的最大大小取决于请求的缩放级别。在给定缩放级别上呈现时，宽度和高度不能超过 4092 像素。注意：跨越 180° 经络的边界框需要特殊处理。对于此类框，东部 maxX 值将为负值，因此小于 180° 子午线以西的 minX 值。若要解决此问题，在请求中传递值 40075016.6855874 之前，应将其添加到 true maxX 值。
boundingzoom	query	True	integer int32	地图视区缩放级别。用于确定是否可以放大视图。
overviewbox	query	True	number[]	EPSG900913投影中概述地图的边界框。当概述框/微型地图具有与main地图不同的版权数据时使用。如果没有小型地图，则使用与 `boundingBox` 相同的坐标。直接调用此终结点时，坐标将作为包含四个坐标的单个字符串传入，用逗号分隔。
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	TrafficIncidentViewport	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

AADToken

这些是 OAuth 2.0 流Microsoft Entra。与 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 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。

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

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

Type: apiKey
In: header

示例

Request traffic incident information for the selected viewport

Sample Request

HTTP

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&copyright=True

Sample Response

Status code:: 200

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ResponseFormat	响应的所需格式。值可以是 json 或 xml。
TrafficIncidentViewport	此对象是从成功的交通事件视区调用返回的
TrafficState	流量状态信息
ViewpResp	视区响应对象

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

ResponseFormat

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

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

TrafficIncidentViewport

此对象是从成功的交通事件视区调用返回的

名称	类型	说明
viewpResp	ViewpResp	视区响应对象

TrafficState

流量状态信息

名称	类型	说明
@trafficAge	integer	从创建流量模型 ID) ，已用时间 (以秒为单位。
@trafficModelId	string	调用交通事件服务时，将使用名为“流量模型 ID”的唯一 ID。它允许从特定流量更新获取信息。流量模型 ID 每分钟更新一次，在超时前有效期为两分钟。

ViewpResp

视区响应对象

名称	类型	说明
@maps	string	指示视区中使用的地图数据的数据提供程序的内部名称。用于支持查询。
@version	string	指示用于生成信息的软件版本。用于支持查询。
copyrightIds	string	如果版权参数值为 true，则包含必须使用视区中的磁贴显示的版权信息的全文
trafficState	TrafficState	流量状态信息