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

Render V2 - Get Map Tile

适用于: 请参阅定价

Get Map Tiles API 允许用户请求矢量或光栅格式的地图图块通常集成到地图控件或 SDK 中。 可以请求的一些示例磁贴是Azure Maps道路图块、实时天气雷达磁贴或使用 Azure Maps Creator 创建的地图磁贴。 默认情况下,Azure Maps使用矢量图块 (Web SDK) 和 Android SDK 的 Web 地图控件。

GET https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI 参数

Name In Required Type Description
api-version
query True
  • string

Azure Maps API 的版本号。 当前版本为 2.1

tilesetId
query True

图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个磁贴集都有一个在发出请求时要使用的 tilesetId 。 使用 Azure Maps Creator 创建的磁贴集的 tilesetId 通过 Tileset Create API 生成。 下面列出了Azure Maps提供的现成磁贴集。 例如,microsoft.base。

x
query True
  • integer
int32

缩放网格上磁贴的 X 坐标。 值必须位于 [0, 2zoom -1] 范围内。

有关详细信息,请参阅 缩放级别和磁贴网格

y
query True
  • integer
int32

缩放网格上磁贴的 Y 坐标。 值必须位于 [0, 2zoom -1] 范围内。

有关详细信息,请参阅 缩放级别和磁贴网格

zoom
query True
  • integer
int32

所需磁贴的缩放级别。

有关详细信息,请参阅 缩放级别和磁贴网格

language
query
  • string

应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一,区分大小写。 当指定语言中的数据不适用于特定字段时,将使用默认语言。

有关详细信息,请参阅 支持的语言

tileSize
query

返回的地图磁贴的大小(以像素为单位)。

timeStamp
query
  • string
date-time

所请求磁贴的所需日期和时间。 此参数必须采用标准日期时间格式 (,例如,2019-11-14T16:03:00-08: 00) ,由 ISO 8601 定义。 仅当 tilesetId 参数设置为以下值之一时,才支持此参数。

  • microsoft.weather.infrared.main:过去最多提供 3 小时的磁贴。 磁贴的间隔为 10 分钟。 我们将 timeStamp 值舍入到最近的 10 分钟时间范围内。
  • microsoft.weather.radar.main:过去最多提供 1.5 小时的磁贴,将来最多提供 2 小时。 磁贴的间隔为 5 分钟。 我们将 timeStamp 值舍入到最近的 5 分钟时间范围。
view
query

View 参数 (也称为“用户区域”参数) 允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区有不同的此类区域视图,View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义视图参数,视图参数也会设置为“统一”。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将根据请求的 IP 地址返回地图数据。 Azure Maps中的 View 参数必须符合适用的法律,包括有关映射的国家/地区、地图、图像和其他数据以及通过Azure Maps获得访问权限的第三方内容。 示例:view=IN。

有关详细信息,请参阅 支持的视图 ,并查看可用的视图。

请求头

Name Required Type Description
x-ms-client-id
  • string

指定哪个帐户旨在与 Azure AD 安全模型结合使用。 它表示Azure Maps帐户的唯一 ID,可以从Azure Maps管理平面帐户 API 检索。 若要在Azure Maps中使用 Azure AD 安全性,请参阅以下文章以获取指导。

响应

Name Type Description
200 OK
  • object

从成功的 API 调用返回的磁贴。

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Headers

  • Content-Type: string
Other Status Codes

发生了意外错误。

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。 与 Azure 基于角色的访问控制配对时,它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个权限组成的自定义角色授予访问权限,以Azure Maps REST API。

若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一种解决方案,用于通过能够针对特定 API 和范围进行访问控制的对象对应用程序 () 建模。

说明

  • 此安全定义需要使用x-ms-client-id标头来指示应用程序请求访问哪些Azure Maps资源。 可以从 地图管理 API 获取此功能。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许为多个用例配置基于应用程序的设置。

  • 目前,Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾,但不支持个人帐户。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
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,以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

这是通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上的列表 SAS 操作创建的共享访问签名令牌。

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

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

Type: apiKey
In: header

示例

Successful Tile Request

Sample Request

GET https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId=microsoft.base&zoom=6&x=10&y=22

Sample Response

Content-Type: application/vnd.mapbox-vector-tile
"binary image string"

定义

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

LocalizedMapView

View 参数 (也称为“用户区域”参数,) 使你可以为某个国家/地区显示地缘政治争议区域的正确地图。 不同国家/地区有不同的此类区域视图,并且 View 参数允许应用程序遵守应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义该参数,View 参数也会设置为“Unified”。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps中的 View 参数必须符合适用法律,包括有关映射、地图、图像和其他数据以及通过Azure Maps获得访问权限的第三方内容的国家/地区。 示例:view=IN。

有关详细信息,请参阅 支持视图 ,并查看可用的视图。

MapTileSize

返回的地图磁贴的大小(以像素为单位)。

TilesetID

图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个图块集都有一个在发出请求时要使用的 tilesetId 。 使用 Azure Maps Creator 创建的磁贴集的 tilesetId 是通过 Tileset Create API 生成的。 下面列出了Azure Maps提供的现成磁贴集。 例如,microsoft.base。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

LocalizedMapView

View 参数 (也称为“用户区域”参数,) 使你可以为某个国家/地区显示地缘政治争议区域的正确地图。 不同国家/地区有不同的此类区域视图,并且 View 参数允许应用程序遵守应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义该参数,View 参数也会设置为“Unified”。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps中的 View 参数必须符合适用法律,包括有关映射、地图、图像和其他数据以及通过Azure Maps获得访问权限的第三方内容的国家/地区。 示例:view=IN。

有关详细信息,请参阅 支持视图 ,并查看可用的视图。

Name Type Description
AE
  • string

阿拉伯联合酋长国(阿拉伯视图)

AR
  • string

阿根廷(阿根廷视图)

Auto
  • string

根据请求的 IP 地址返回地图数据。

BH
  • string

巴林(阿拉伯视图)

IN
  • string

印度(印度视图)

IQ
  • string

伊拉克(阿拉伯视图)

JO
  • string

约旦(阿拉伯视图)

KW
  • string

科威特(阿拉伯视图)

LB
  • string

黎巴嫩(阿拉伯视图)

MA
  • string

摩洛哥(摩洛哥视图)

OM
  • string

阿曼(阿拉伯视图)

PK
  • string

巴基斯坦(巴基斯坦视图)

PS
  • string

巴勒斯坦权力机构(阿拉伯视图)

QA
  • string

卡塔尔(阿拉伯视图)

SA
  • string

沙特阿拉伯(阿拉伯视图)

SY
  • string

叙利亚(阿拉伯视图)

Unified
  • string

统一视图(其他)

YE
  • string

也门(阿拉伯视图)

MapTileSize

返回的地图磁贴的大小(以像素为单位)。

Name Type Description
256
  • string

返回 256 x 256 像素磁贴。

512
  • string

返回 512 x 512 像素磁贴。

TilesetID

图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个图块集都有一个在发出请求时要使用的 tilesetId 。 使用 Azure Maps Creator 创建的磁贴集的 tilesetId 是通过 Tileset Create API 生成的。 下面列出了Azure Maps提供的现成磁贴集。 例如,microsoft.base。

Name Type Description
microsoft.base
  • string

基本地图是一种标准地图,用于显示道路、自然特征和人工特征以及矢量图块中这些功能的标签。

支持缩放级别 0 到 22。 格式:矢量 (pbf) 。

microsoft.base.darkgrey
  • string

所有层都采用深灰色样式。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.base.hybrid
  • string

在向量图块中显示道路、边界和标签数据。

支持缩放级别 0 到 22。 格式:矢量 (pbf) 。

microsoft.base.hybrid.darkgrey
  • string

我们的深灰色样式中的道路、边界和标签数据。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.base.hybrid.road
  • string

主要样式中的道路、边界和标签数据。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.base.labels
  • string

在矢量图块中显示道路、自然和人工特征的标签。

支持缩放级别 0 到 22。 格式:矢量 (pbf) 。

microsoft.base.labels.darkgrey
  • string

标记深灰色样式中的数据。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.base.labels.road
  • string

在主样式中标记数据。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.base.road
  • string

具有主要样式的所有层。

支持缩放级别 0 到 22。 格式:光栅 (png) 。

microsoft.dem
  • string

数字提升模型磁贴。 磁贴采用 GeoTIFF 格式,具有单个 32 位浮点带。 磁贴覆盖着地球的整个陆地。 一些小岛屿 (,例如,) 的环礁可能无法准确表示。

  • 用于测量高程高度的垂直单位为米。 高程值 -32767.0 用于没有数据值的点,通常返回的点没有陆地 (,即水) 。
  • 水平引用基准是 1984 年世界地理系统 1984 (WGS84-G1150) ,垂直参考基准是地球引力模型 2008 (EGM2008) 。
  • 图块是 258x258 像素方形,而不是标准 256 x 256。 这样做是为了允许在图块边缘准确内插值。 因此,相邻磁贴在所有边缘上以 1 像素重叠。
  • 磁贴数据来自 空客 WorldDEM4Ortho 产品。 城市地区大致平到地面。 所有其他区域都由对象图面级别 (表示,例如树) 。

仅支持缩放级别 13。 格式:光栅 (差异) 。

microsoft.dem.contours
  • string

数字高程轮廓线图块。 与 microsoft.dem 选项相比,这些磁贴采用矢量格式,旨在实现可视化目的。 磁贴覆盖着地球的整个陆地。 一些小岛屿 (,例如,) 的环礁可能无法准确表示。

  • 用于测量高程高度的垂直单位为米。
  • 水平引用基准是 1984 年世界地理系统 1984 (WGS84-G1150) ,垂直参考基准是地球引力模型 2008 (EGM2008) 。
  • 磁贴数据来自 空客 WorldDEM4Ortho 产品。 城市地区大致平到地面。 所有其他区域都由对象图面级别 (表示,例如树) 。

支持缩放级别 9 到 14。 格式:矢量 (pbf) 。

microsoft.imagery
  • string

卫星和空中图像的组合。 仅在 S1 定价 SKU 中可用。

支持缩放级别 1 到 19。 格式:光栅 (jpeg) 。

microsoft.terra.main
  • string

着色浮雕和地层。

支持缩放级别 0 到 6。 格式:光栅 (png) 。

microsoft.traffic.absolute
  • string

矢量中的绝对流量磁贴

microsoft.traffic.absolute.main
  • string

主样式光栅中的绝对流量磁贴。

microsoft.traffic.delay
  • string

矢量中的流量磁贴

microsoft.traffic.delay.main
  • string

主样式光栅中的交通磁贴

microsoft.traffic.incident
  • string

矢量中的事件磁贴

microsoft.traffic.reduced.main
  • string

减少主样式光栅中的交通磁贴

microsoft.traffic.relative
  • string

矢量中的相对流量磁贴

microsoft.traffic.relative.dark
  • string

我们深色样式中光栅中的相对交通图块。

microsoft.traffic.relative.main
  • string

主样式光栅中的相对流量磁贴。

microsoft.weather.infrared.main
  • string

天气红外磁贴。 最新的红外卫星图像按其温度显示云。 请参阅Azure Maps天气服务的覆盖范围信息。 若要了解有关返回的卫星数据的详细信息,请参阅 天气概念

支持缩放级别 0 到 15。 格式:光栅 (png) 。

microsoft.weather.radar.main
  • string

天气雷达图块。 最新的天气雷达图像,包括雨、雪、冰和混合条件。 请参阅Azure Maps天气服务的覆盖范围信息。 若要了解有关雷达数据的详细信息,请参阅 天气概念

支持缩放级别 0 到 15。 格式:光栅 (png) 。