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

Search - Get Search Address Reverse Cross Street

反向地理编码到十字街

适用于: 查看定价

有时,需要将坐标转换为 (示例: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 参数

Name In Required Type Description
format
path True

响应的所需格式。 值可以是 jsonxml

api-version
query True
  • string

Azure Maps API 的版本号。

query
query True
  • array

指定为逗号分隔字符串的适用查询,后跟经度,例如“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。

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

请求头

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

OK

Other Status Codes

发生了意外错误。

安全性

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

示例

Search address of the nearest intersection/crossroad

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89

Sample Response

{
  "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",
        "countrySubdivision": "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

结果的地址

BoundingBoxCompassNotation

位置的边界框。

Entity

边界框的实体类型源。 对于反向地理编码,这始终等于位置。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

LatLongPairAbbreviated

使用短名称“lat” & “lon”表示为纬度和经度的位置。

LocalizedMapView

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

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

QueryType

要返回的查询类型:NEARBY 或 NON_NEAR。

ResponseFormat

响应的所需格式。 值可以是 jsonxml

ReverseSearchCrossStreetAddressResult

此对象是从成功的搜索地址反向 CrossStreet 调用返回的

ReverseSearchCrossStreetAddressResultItem

搜索地址反向交叉街响应的结果对象

SearchSummary

搜索 API 响应的摘要对象。

Address

结果的地址

Name Type Description
boundingBox

位置的边界框。

buildingNumber
  • string

街上的建筑号。 已弃用,请改用 streetNumber。

country
  • string

国家/地区名称

countryCode
  • string

国家/地区 (注意:这是一个双字母代码,而不是国家/地区名称。)

countryCodeISO3
  • string

ISO alpha-3 国家/地区代码

countrySecondarySubdivision
  • string

countrySubdivision
  • string

省/市/自治区

countrySubdivisionName
  • string

国家/地区管理层次结构的第一级的完整名称。 仅当 countrySubdivision 以缩写形式显示时,才会显示此字段。 仅支持美国、加拿大和英国。

countryTertiarySubdivision
  • string

命名区域

crossStreet
  • string

要交叉的街道的名称。

extendedPostalCode
  • string

扩展邮政编码 (可用性取决于区域) 。

freeformAddress
  • string

根据 Result 所在国家/地区的格式设置规则设置格式的地址行,或者对于国家/地区,其完整国家/地区名称。

localName
  • string

一个地址组件,表示地理区域或区域的名称,用于对多个可寻址对象进行分组以实现寻址目的,而不作为管理单元。 此字段用于生成 freeformAddress 属性。

municipality
  • string

城市/城镇

municipalitySubdivision
  • string

子/超级城市

postalCode
  • string

邮政编码/邮政编码

routeNumbers
  • string[]

用于明确标识街道的代码

street
  • string

街道名称。 已弃用,请改用 streetName。

streetName
  • string

街道名称。

streetNameAndNumber
  • string

街道名称和数字。

streetNumber
  • string

街上的建筑号。

BoundingBoxCompassNotation

位置的边界框。

Name Type Description
entity

边界框的实体类型源。 对于反向地理编码,这始终等于位置。

northEast
  • string

以逗号分隔的浮点数形式表示边界框的东北纬度、经度坐标

southWest
  • string

西南纬度,边界框的经度坐标为逗号分隔浮点数

Entity

边界框的实体类型源。 对于反向地理编码,这始终等于位置。

Name Type Description
position
  • string

位置实体

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

错误对象。

LatLongPairAbbreviated

使用短名称“lat” & “lon”表示为纬度和经度的位置。

Name Type Description
lat
  • number

Latitude 属性

lon
  • number

经度属性

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

也门(阿拉伯视图)

QueryType

要返回的查询类型:NEARBY 或 NON_NEAR。

Name Type Description
NEARBY
  • string

搜索是在具有定义半径的特定纬度和经度周围执行的

NON_NEAR
  • string

全局执行搜索,不偏向特定纬度和经度,也没有定义的半径

ResponseFormat

响应的所需格式。 值可以是 jsonxml

Name Type Description
json
  • string

JavaScript 对象表示法数据交换格式

xml
  • string

可扩展标记语言

ReverseSearchCrossStreetAddressResult

此对象是从成功的搜索地址反向 CrossStreet 调用返回的

Name Type Description
addresses

地址数组

summary

搜索地址反向交叉街响应的摘要对象

ReverseSearchCrossStreetAddressResultItem

搜索地址反向交叉街响应的结果对象

Name Type Description
address

结果的地址

position
  • string

Position 属性采用“{latitude},{longitude}”的形式

SearchSummary

搜索 API 响应的摘要对象。

Name Type Description
fuzzyLevel
  • integer

提供结果所需的最大模糊级别。

geoBias

指示内部搜索引擎何时应用地理空间偏差来提高结果排名。 在某些方法中,可以通过设置 lat 和 lon 参数(如果可用)而受到影响。 在其他情况下,它纯粹是内部的。

limit
  • integer

将返回的最大响应数

numResults
  • integer

响应中的结果数。

offset
  • integer

完整结果集中返回的结果的起始偏移量。

query
  • string

用于生成这些搜索结果的查询参数。

queryTime
  • integer

解析查询所用的时间(以毫秒为单位)。

queryType

要返回的查询类型:NEARBY 或 NON_NEAR。

totalResults
  • integer

找到的结果总数。