Render - Get Map Static Image
此呈现 API 生成用户定义的区域的静态光栅化地图视图。 它适用于轻型 Web 应用程序,当所需的用户体验不需要交互式地图控件或带宽受限时。 此 API 还可用于在浏览器外部、后端服务、报表生成或桌面应用程序中嵌入映射。
此 API 包括基本数据可视化的参数:
- 多个样式中标记的图钉。
- 呈现圆形、路径和多边形几何图形类型。
有关详细信息和详细示例,请参阅 光栅地图上呈现自定义数据。
bbox 参数的尺寸受约束,具体取决于缩放级别。 这可确保生成的图像具有适当的详细信息级别。
缩放级别 | Min Lon Range | 最大 Lon 范围 | Min Lat 范围 | 最大 Lat 范围 |
---|---|---|---|---|
0 | 56.25 | 360.0 | 30.1105585173 | 180.0 |
1 | 28.125 | 360.0 | 14.87468995 | 180.0 |
2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |
3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |
4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |
5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |
6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |
7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |
8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |
9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |
10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |
11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |
12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |
13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |
14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |
15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |
16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 |
十七 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |
18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |
19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |
20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 |
注意:必须向 API 提供 中心 或 bbox 参数。
GET https://atlas.microsoft.com/map/static?api-version=2024-04-01
GET https://atlas.microsoft.com/map/static?api-version=2024-04-01&tilesetId={tilesetId}&trafficLayer={trafficLayer}&zoom={zoom}¢er={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 当前版本为2024-04-01。 |
||||||||||||||||||||||||||||||||||||
bbox
|
query |
number[] |
边界框由两个纬度和两个经度定义,表示地球上矩形区域的四侧。 格式:“minLon、minLat、maxLon、maxLat”(双精度)。 注意:bbox 或中心是必需参数。 它们是相互排斥的。 bbox 不应与高度或宽度一起使用。 Lat 和 Lon 允许的最大范围和最小范围是为本页顶部表格中的每个缩放级别定义的。 |
|||||||||||||||||||||||||||||||||||||
center
|
query |
number[] |
中心点的坐标(以双精度为单位)。 格式:“lon,lat”。 经度范围:-180 到 180。 纬度范围:-90 到 90。 注意:中心或 bbox 是必需参数。 它们是相互排斥的。 |
|||||||||||||||||||||||||||||||||||||
height
|
query |
integer (int32) minimum: 80maximum: 1500 |
生成的图像的高度(以像素为单位)。 范围为 80 到 1500。 默认值为 512。 它不应与 bbox 一起使用。 |
|||||||||||||||||||||||||||||||||||||
language
|
query |
string |
应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一,不区分大小写。 当指定语言中的数据不适用于特定字段时,将使用默认语言。 有关详细信息,请参阅 支持的语言。 |
|||||||||||||||||||||||||||||||||||||
path
|
query |
string[] |
路径样式和位置(以双精度为单位)。 使用此参数可以选择向图像添加线条、多边形或圆圈。 路径样式描述线条和填充的外观。 (请务必正确编码此参数的 URL 编码值,因为它将包含保留字符,如管道和标点符号。 从 S1 开始,Azure Maps 帐户 SKU 支持路径参数。 路径参数的多个实例允许使用其样式指定多个几何图形。 每个请求的参数数限制为 10,每个路径的位置数限制为 100。 若要使用默认样式呈现半径为 100 米且中心点为纬度 45°N 和经度 122°W 的圆圈,请添加 querystring 参数
请注意,经度在纬度之前。 URL 编码后,如下所示
为了清楚起见,此处的所有示例都显示了没有 URL 编码的路径参数。 若要呈现一行,请使用管道字符分隔每个位置。 例如,使用
使用封闭路径指定多边形,其中第一个和最后一个点相等。 例如,使用
线条和多边形位置的经度值可以介于从 -360 到 360 之间,以允许呈现跨越反经线的几何图形。 样式修饰符可以通过添加样式修饰符来修改路径的外观。 这些是在位置之前添加的。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。 若要更改轮廓的颜色,请使用“lc”样式修饰符,并使用 HTML/CSS RGB 颜色格式指定颜色,该格式是六位数十六进制数字(不支持三位数形式)。 例如,若要使用深粉色(将在 CSS 中指定为 #FF1493),请使用
可以组合多个样式修饰符来创建更复杂的视觉样式。
样式修饰符摘要
|
|||||||||||||||||||||||||||||||||||||
pins
|
query |
string[] |
图钉样式和实例。 使用此参数可以选择性地向图像添加图钉。 图钉样式描述图钉的外观,实例为每个图钉指定图钉(以双精度为单位)和可选标签的坐标。 (请务必正确编码此参数的 URL 编码值,因为它将包含保留字符,如管道和标点符号。 Azure Maps 帐户 S0 SKU 仅支持固定参数的单个实例,并且每个引脚的位置数限制为 5 个。 其他 SKU 最多允许 25 个引脚参数实例指定多个引脚样式,并且每个引脚的位置数限制为 50 个。 若要使用默认的内置图钉样式在纬度 45°N 和经度 122°W 处呈现图钉,请添加 querystring 参数
请注意,经度在纬度之前。 URL 编码后,如下所示
为了清楚起见,此处的所有示例都显示了没有 URL 编码的引脚参数。 若要在多个位置呈现图钉,请使用管道字符分隔每个位置。 例如,使用
S0 Azure Maps 帐户 SKU 仅允许五个图钉。 其他帐户 SKU 没有此限制。 样式修饰符可以通过添加样式修饰符来修改图钉的外观。 这些内容将添加到样式之后,但在位置和标签之前。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。 若要更改图钉的颜色,请使用“co”样式修饰符,并使用 HTML/CSS RGB 颜色格式指定颜色,该格式是六位数十六进制数字(不支持三位数形式)。 例如,若要使用深粉色(将在 CSS 中指定为 #FF1493),请使用
图钉标签若要将标签添加到图钉,请将标签放在坐标前的单引号中。 避免在标签中使用特殊字符,例如
有一个名为“none”的内置图钉样式,不显示图钉图像。 如果要显示不带任何固定图像的标签,可以使用此功能。 例如,
若要更改图钉标签的颜色,请使用“lc”标签颜色样式修饰符。 例如,若要将粉红色图钉与黑色标签一起使用,请使用
若要更改标签的大小,请使用“ls”标签大小样式修饰符。 标签大小表示标签文本的近似高度(以像素为单位)。 例如,若要将标签大小增加到 12,请使用
标签居中位于图钉“标签定位点”。 定位点位置是内置图钉的预定义位置,位于自定义图钉的顶部中心(请参阅下文)。 若要重写标签定位点,请使用“la”样式修饰符并为定位点提供 X 和 Y 像素坐标。 这些坐标相对于图钉图像的左上角。 正 X 值将定位点移到右侧,正 Y 值将定位点向下移动。 例如,若要将标签定位点向右定位 10 像素,将 4 像素置于图钉图像左上角上方,请使用
自定义图钉若要使用自定义图钉图像,请使用“custom”一词作为固定样式名称,然后在位置和标签信息后面指定 URL。 自定义标签图像允许的最大大小为 65,536 像素。 使用两个管道字符指示你已完成指定位置并正在启动 URL。 例如,
URL 编码后,如下所示
默认情况下,自定义图钉图像以固定坐标居中绘制。 这通常并不理想,因为它掩盖了要突出显示的位置。 若要替代固定图像的定位点位置,请使用“an”样式修饰符。 这使用与“la”标签定位点样式修饰符相同的格式。 例如,如果自定义图钉图像具有图像左上角的图钉尖,则可以使用
注意:如果将“co”颜色修饰符与自定义图钉图像一起使用,则指定的颜色将替换图像中像素的 RGB 通道,但会使 alpha(不透明度)通道保持不变。 这通常只能通过纯色自定义图像来完成。 缩放、旋转和不透明度可以使用“sc”刻度样式修饰符使图钉及其标签更大或更小。 这是大于零的值。 值为 1 即为标准比例。 大于 1 的值会使引脚变大,小于 1 的值会使它们更小。 例如,若要绘制图钉 50% 大于正常,请使用
可以使用“ro”旋转样式修饰符旋转图钉及其标签。 这是一些顺时针旋转度。 使用负数逆时针旋转。 例如,若要顺时针旋转 90 度图钉并加倍其大小,请使用
可以通过指定“al”alpha 样式修饰符使图钉及其标签部分透明。 这是一个介于 0 和 1 之间的数字,指示图钉的不透明度。 零会使它们完全透明(且不可见),1 使它们完全不透明(这是默认值)。 例如,若要使图钉及其标签只有 67% 不透明,请使用
样式修饰符摘要
|
|||||||||||||||||||||||||||||||||||||
tileset
|
query |
要返回的地图样式。 可能的值为 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默认值设置为 microsoft.base.road。 有关详细信息,请参阅 Render TilesetId。 |
||||||||||||||||||||||||||||||||||||||
traffic
|
query |
可选值,指示图像结果上没有覆盖任何流量流。 可能的值为 microsoft.traffic.relative.main 和 none。 默认值为 none,表示未返回任何流量流。 如果提供了与流量相关的 tilesetId,则返回具有相应流量层的映射图像。 有关详细信息,请参阅 Render TilesetId。 |
||||||||||||||||||||||||||||||||||||||
view
|
query |
View 参数(也称为“用户区域”参数)允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图,并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义该参数,View 参数也会设置为“Unified”。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律,包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例:view=IN。 有关详细信息,请参阅 支持的视图,并查看可用的视图。 |
||||||||||||||||||||||||||||||||||||||
width
|
query |
integer (int32) minimum: 80maximum: 2000 |
生成的图像的宽度(以像素为单位)。 范围为 80 到 2000。 默认值为 512。 它不应与 bbox 一起使用。 |
|||||||||||||||||||||||||||||||||||||
zoom
|
query |
integer (int32) minimum: 0maximum: 20 |
地图的所需缩放级别。 支持 tilesetId 为 microsoft.base.road 或 microsoft.base.darkgrey 的缩放值范围为 0-20(含)。 支持将 tilesetId 作为 microsoft.imagery 的缩放值范围为 0-19(含)。 默认值为 12。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定哪个帐户与 Microsoft Entra ID 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
|
Accept |
“接受”标头字段可用于指定有关响应介质类型的首选项。 允许的媒体类型包括 image/jpeg 和 image/png。 如果未指定 Accept 标头,则返回 image/png 格式的图像。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
object |
此图像是从成功的获取映射静态图像调用返回的。 Media Types: "image/jpeg", "image/png" 标头 Content-Type: string |
Other Status Codes |
发生意外错误。 Media Types: "image/jpeg", "image/png" |
安全性
AADToken
这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时, 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST 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 管理平面创建 Azure Maps 资源 时预配的共享密钥。
使用此密钥,任何应用程序都有权访问所有 REST API。 换句话说,这些密钥当前可视为为其颁发的帐户的主密钥。
对于公开的应用程序,我们建议使用可安全地存储此密钥的 Azure Maps REST API 的服务器到服务器访问。
类型:
apiKey
在:
header
SAS Token
这是一个共享访问签名令牌,它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,建议在 映射帐户资源 上配置允许的源的特定列表,以限制呈现滥用并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Successful Static Image Request
示例请求
GET https://atlas.microsoft.com/map/static?api-version=2024-04-01&tilesetId=microsoft.base.road&zoom=10¢er=-122.177621,47.613079
示例响应
Content-Type: image/png
"{file}"
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Localized |
View 参数(也称为“用户区域”参数)允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图,并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义该参数,View 参数也会设置为“Unified”。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律,包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例:view=IN。 有关详细信息,请参阅 支持的视图,并查看可用的视图。 |
Media |
“接受”标头字段可用于指定有关响应介质类型的首选项。 允许的媒体类型包括 image/jpeg 和 image/png。 如果未指定 Accept 标头,则返回 image/png 格式的图像。 |
Tileset |
要返回的地图样式。 可能的值为 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默认值设置为 microsoft.base.road。 有关详细信息,请参阅 Render TilesetId。 |
Traffic |
可选值,指示图像结果上没有覆盖任何流量流。 可能的值为 microsoft.traffic.relative.main 和 none。 默认值为 none,表示未返回任何流量流。 如果提供了与流量相关的 tilesetId,则返回具有相应流量层的映射图像。 有关详细信息,请参阅 Render TilesetId。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
LocalizedMapView
View 参数(也称为“用户区域”参数)允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图,并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下,即使尚未在请求中定义该参数,View 参数也会设置为“Unified”。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律,包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例:view=IN。
有关详细信息,请参阅 支持的视图,并查看可用的视图。
值 | 说明 |
---|---|
AE |
阿拉伯联合酋长国(阿拉伯视图) |
AR |
阿根廷(阿根廷视图) |
BH |
巴林(阿拉伯视图) |
IN |
印度(印度视图) |
IQ |
伊拉克(阿拉伯视图) |
JO |
约旦(阿拉伯视图) |
KW |
科威特(阿拉伯视图) |
LB |
黎巴嫩(阿拉伯视图) |
MA |
摩洛哥(摩洛哥视图) |
OM |
阿曼(阿拉伯视图) |
PK |
巴基斯坦(巴基斯坦视图) |
PS |
巴勒斯坦权力机构(阿拉伯视图) |
QA |
卡塔尔(阿拉伯视图) |
SA |
沙特阿拉伯(阿拉伯视图) |
SY |
叙利亚(阿拉伯视图) |
YE |
也门(阿拉伯视图) |
Auto |
根据请求的 IP 地址返回映射数据。 |
Unified |
统一视图(其他) |
MediaType
“接受”标头字段可用于指定有关响应介质类型的首选项。 允许的媒体类型包括 image/jpeg 和 image/png。 如果未指定 Accept 标头,则返回 image/png 格式的图像。
值 | 说明 |
---|---|
image/png |
以 png 格式返回图像。 |
image/jpeg |
以 jpeg 格式返回图像。 |
TilesetId
要返回的地图样式。 可能的值为 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默认值设置为 microsoft.base.road。 有关详细信息,请参阅 Render TilesetId。
值 | 说明 |
---|---|
microsoft.base.road |
TilesetId 包含具有渲染主样式的所有图层。 |
microsoft.base.darkgrey |
TilesetId 包含所有具有深灰色样式的图层。 |
microsoft.imagery |
TilesetId 包含卫星和航空图像的组合。 |
TrafficTilesetId
可选值,指示图像结果上没有覆盖任何流量流。 可能的值为 microsoft.traffic.relative.main 和 none。 默认值为 none,表示未返回任何流量流。 如果提供了与流量相关的 tilesetId,则返回具有相应流量层的映射图像。 有关详细信息,请参阅 Render TilesetId。
值 | 说明 |
---|---|
microsoft.traffic.relative.main |
支持与流量相关的 tilesetId。 |
none |
默认值,无流量覆盖。 |