你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Search - Get Search Address Reverse Cross Street
用于从纬度和经度坐标获取十字路口位置信息。
API Get Search Address Reverse Cross Street
是一个 HTTP GET
请求,在给定纬度和经度坐标时返回最近的十字路口。 有时可能需要将坐标 (示例:37.786505、-122.3862) 转换为人类可理解的十字路口。 在从设备或资产接收 GPS 源并希望知道坐标所在的地址的跟踪应用程序中,这通常是需要的。
此终结点将返回给定坐标的十字路口信息。
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
query
|
query | True |
number[] |
指定为逗号分隔字符串的适用查询,该字符串由纬度后跟经度组成,例如“47.641268,-122.125679”。 |
heading
|
query |
integer |
车辆的方向方向,以度为单位,用于沿一段路段行驶。 0 为 North,90 为 East,依依类而行,值范围为 -360 到 360。 精度最多可以包含一个小数位数 |
|
language
|
query |
string |
返回搜索结果时应采用的语言。 应是受支持的 IETF 语言标记之一,不区分大小写。 当指定语言的数据不适用于特定字段时,将使用默认语言。 有关详细信息,请参阅 支持的语言 。 |
|
limit
|
query |
integer |
将返回的最大响应数。 默认值:10,最小值:1,最大值:100 |
|
radius
|
query |
integer |
结果要限制为已定义区域的半径(以米为单位) |
|
view
|
query |
View 参数 (也称为“用户区域”参数) 允许你为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图,并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下,View 参数设置为“Unified”,即使尚未在请求中定义它。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律,包括与地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区相关的法律。 示例:view=IN。 有关详细信息和可用的 视图 ,请参阅支持的视图。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 Map 帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Search address of the nearest intersection/crossroad
示例请求
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89
示例响应
{
"summary": {
"numResults": 1,
"queryTime": 41
},
"addresses": [
{
"address": {
"streetName": "East Santa Clara Street & North 2nd Street",
"crossStreet": "East Santa Clara Street",
"municipalitySubdivision": "San Jose, Downtown San Jose",
"municipality": "San Jose",
"countrySecondarySubdivision": "Santa Clara",
"countryTertiarySubdivision": "San Jose",
"countrySubdivisionCode": "CA",
"postalCode": "95113",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
"countrySubdivisionName": "California"
},
"position": "37.33666,-121.88951"
}
]
}
定义
名称 | 说明 |
---|---|
Address |
结果的地址 |
Bounding |
位置的边界框。 |
Entity |
边界框的实体类型源。 对于反向地理编码,这始终等于位置。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Lat |
使用短名称“lat”&“lon”表示为纬度和经度的位置。 |
Localized |
View 参数 (也称为“用户区域”参数,) 允许您为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图,并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下,View 参数设置为“Unified”,即使你尚未在请求中定义它。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律,包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例:view=IN。 有关详细信息,请参阅 支持的视图 ,并查看可用的视图。 |
Query |
返回的查询类型:“附近”或“NON_NEAR”。 |
Response |
响应的所需格式。 值可以是 json 或 xml。 |
Reverse |
此对象是从成功搜索地址反向跨街调用返回的 |
Reverse |
搜索地址反向十字街响应的结果对象 |
Search |
搜索 API 响应的摘要对象。 |
Address
结果的地址
名称 | 类型 | 说明 |
---|---|---|
boundingBox |
位置的边界框。 |
|
buildingNumber |
string |
街上的建筑号。 已弃用,请改用 streetNumber。 |
country |
string |
国家/地区名称 |
countryCode |
string |
国家/地区 (注意:这是一个双字母代码,而不是国家/地区名称。) |
countryCodeISO3 |
string |
ISO alpha-3 国家/地区代码 |
countrySecondarySubdivision |
string |
县 |
countrySubdivision |
string |
省/市/自治区 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
国家/地区管理层次结构的第一个级别的全名。 仅当 countrySubdivision 以缩写形式显示时,才会显示此字段。 仅支持美国、加拿大和英国。 |
countryTertiarySubdivision |
string |
命名区域 |
crossStreet |
string |
要交叉的街道的名称。 |
extendedPostalCode |
string |
扩展邮政编码 (可用性取决于区域) 。 |
freeformAddress |
string |
根据结果所在国家/地区/地区的格式规则设置格式的地址行,如果是国家/地区,则为完整的国家/地区名称。 |
localName |
string |
一个地址组件,表示地理区域或位置的名称,该地理区域或位置将多个可寻址对象分组用于寻址目的,而不作为管理单元。 此字段用于生成 |
municipality |
string |
市/镇 |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
邻里是城市或城镇内的地理局部区域,具有鲜明的特点和居民之间的社会互动。 |
postalCode |
string |
邮政编码/邮政编码 |
routeNumbers |
string[] |
用于明确标识街道的代码 |
street |
string |
街道名称。 已弃用,请改用 streetName。 |
streetName |
string |
街道名称。 |
streetNameAndNumber |
string |
街道名称和编号。 |
streetNumber |
string |
街上的建筑号。 |
BoundingBoxCompassNotation
位置的边界框。
名称 | 类型 | 说明 |
---|---|---|
entity |
边界框的实体类型源。 对于反向地理编码,这始终等于位置。 |
|
northEast |
string |
以逗号分隔浮点分隔的边界框的东北纬度、经度坐标 |
southWest |
string |
以逗号分隔的浮点为边界框的西南纬度、经度坐标 |
Entity
边界框的实体类型源。 对于反向地理编码,这始终等于位置。
名称 | 类型 | 说明 |
---|---|---|
position |
string |
位置实体 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
LatLongPairAbbreviated
使用短名称“lat”&“lon”表示为纬度和经度的位置。
名称 | 类型 | 说明 |
---|---|---|
lat |
number |
Latitude 属性 |
lon |
number |
Longitude 属性 |
LocalizedMapView
View 参数 (也称为“用户区域”参数,) 允许您为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图,并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下,View 参数设置为“Unified”,即使你尚未在请求中定义它。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律,包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例:view=IN。
有关详细信息,请参阅 支持的视图 ,并查看可用的视图。
名称 | 类型 | 说明 |
---|---|---|
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 |
也门(阿拉伯视图) |
QueryType
返回的查询类型:“附近”或“NON_NEAR”。
名称 | 类型 | 说明 |
---|---|---|
NEARBY |
string |
搜索是在具有定义半径的特定纬度和经度周围执行的 |
NON_NEAR |
string |
搜索是全局执行的,没有偏向于特定的纬度和经度,也没有定义的半径 |
ResponseFormat
响应的所需格式。 值可以是 json 或 xml。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
|
xml |
string |
ReverseSearchCrossStreetAddressResult
此对象是从成功搜索地址反向跨街调用返回的
名称 | 类型 | 说明 |
---|---|---|
addresses |
地址数组 |
|
summary |
搜索地址反向十字街响应的摘要对象 |
ReverseSearchCrossStreetAddressResultItem
搜索地址反向十字街响应的结果对象
名称 | 类型 | 说明 |
---|---|---|
address |
结果的地址 |
|
position |
string |
格式为“{latitude},{longitude}”的 Position 属性 |
SearchSummary
搜索 API 响应的摘要对象。
名称 | 类型 | 说明 |
---|---|---|
fuzzyLevel |
integer |
提供结果所需的最大模糊级别。 |
geoBias |
指示内部搜索引擎何时应用地理空间偏差来提高结果排名。 在某些方法中,这可以通过设置 lat 和 lon 参数(如果可用)而受到影响。 在其他情况下,它纯粹是内部的。 |
|
limit |
integer |
将返回的最大响应数 |
numResults |
integer |
响应中的结果数。 |
offset |
integer |
返回的结果在完整结果集中的起始偏移量。 |
query |
string |
用于生成这些搜索结果的查询参数。 |
queryTime |
integer |
解析查询所用的时间(以毫秒为单位)。 |
queryType |
返回的查询类型:“附近”或“NON_NEAR”。 |
|
totalResults |
integer |
找到的结果总数。 |