Search - Post Search Address Reverse Batch Sync

使用 在单个同步请求中将一批查询发送到 搜索 地址 API。
Get Search Address Batch API 是一个 HTTP GET 请求，它通过单个同步 API 调用将成批的查询发送到 搜索 Address API。 可以调用 搜索 地址反向批处理 API，以异步 (异步) 运行，或同步 (同步) 运行。 异步 API 允许调用方批处理最多 10,000 个 查询，并同步 API 最多 100 个查询。

提交同步批处理请求

对于轻型批处理请求，建议使用同步 API。 当服务收到请求时，它将在计算批处理项后立即响应，并且以后无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将返回超时错误 (408 响应) 。 此 API 的批处理项数限制为 100 个。

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

提交异步批处理请求

异步 API 适用于处理大量相对复杂的搜索请求

• 它允许在单独的调用中检索结果， () 多个下载。
• 异步 API 针对可靠性进行优化，预计不会遇到超时。
• 此 API 的批处理项数限制为 10,000 个。

使用异步请求发出请求时，默认情况下，服务会沿着响应标头的“位置”字段中的重定向 URL 返回 202 响应代码。 应定期检查此 URL，直到响应数据或错误信息可用。 异步响应将存储 14 天。 如果过期后使用重定向 URL，则返回 404 响应。

请注意，异步批处理请求是一个长时间运行的操作。 下面是一个典型的操作序列：

1. 客户端向Azure Maps发送搜索地址反向批处理POST请求。

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

2. 服务器将使用以下项之一进行响应：

   HTTP 202 Accepted - 已接受 Batch 请求。

   HTTP Error - 处理 Batch 请求时出错。 这可以是 400 Bad Request 或任何其他 Error 状态代码。

3. 如果已成功接受批处理请求，则 Location 响应中的 标头包含用于下载批处理请求结果的 URL。 此状态 URI 如下所示：

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

4. 客户端在步骤 3 中获取的下载 URL 上发出GET请求，以下载批处理结果。

批处理请求的 POST 正文

若要发送搜索地址反向查询，你将使用请求POST，其中请求正文将包含格式的batchItemsjson数组，Content-Type并且标头将设置为 application/json。 下面是包含 5 个 搜索地址反向 查询的请求正文示例：

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

批处理中的 搜索地址反向 查询只是部分 URL， 没有 协议、基 URL、路径、api-version 和 subscription-key。 它可以接受任何受支持的 搜索地址反向URI 参数。 搜索地址反向查询中的字符串值必须正确转义 (例如“字符应使用 \ ) 转义，并且还应正确进行 URL 编码。

异步 API 允许调用方批处理最多 10,000 个 查询，并同步 API 最多 100 个查询，并且批处理应至少包含 1 个 查询。

下载异步批处理结果

若要下载异步批处理结果，需向批量下载终结点发出 GET 请求。 可以从成功的POST批处理请求的标头获取Location此下载 URL，如下所示：

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

下面是用于下载批处理结果的典型操作序列：

1. 客户端使用下载 URL 发送GET请求。

2. 服务器将使用以下项之一进行响应：

   HTTP 202 Accepted - 已接受批处理请求，但仍在处理中。 请稍后重试。

   HTTP 200 OK - 已成功处理批处理请求。 响应正文包含所有批处理结果。

批处理响应模型

对于异步请求和同步请求，返回的数据内容类似。 下载异步批处理请求的结果时，如果批处理已完成处理，响应正文将包含批处理响应。 此批处理响应包含一个 summary 组件，该组件指示 totalRequests 是原始批处理请求的一部分， successfulRequests即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems将包含结果的顺序与原始查询在批处理请求中的发送顺序完全相同。 中的每个 batchItems 项都包含 statusCode 和 response 字段。 response中的每个 batchItems 类型为以下类型之一：

• SearchAddressReverseResponse - 如果查询成功完成。

• Error - 如果查询失败。 在本例中，响应将包含 code 和 message 。

下面是一个示例批处理响应，结果为 2 个成功 ，1 个失败 ：

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0

URI 参数

请求头

请求正文

响应

安全性

AADToken

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

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

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

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

示例

A Reverse Geocoding Batch API Sync call containing 5 Reverse Geocoding API queries

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=48.858561,2.294911"
    },
    {
      "query": "?query=47.639765,-122.127896&radius=5000&limit=2"
    },
    {
      "query": "?query=47.621028,-122.348170"
    }
  ]
}

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定义

Address

结果的地址

AddressRanges

描述搜索结果街道两侧的地址范围。 包括地址范围的开始和结束位置的坐标。

BatchRequest

此类型表示 Batch 服务的请求正文。

BatchRequestItem

Batch 请求对象

BoundingBox

覆盖视区左上坐标和右下坐标表示的结果的视区。

BoundingBoxCompassNotation

位置的边界框。

Brand

与 POI 关联的品牌

Classification

要返回的 POI 的分类

ClassificationName

分类的名称

DataSources

可选节。 用于 Get 搜索 Polygon API 的引用 ID。

Entity

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

EntryPoint

要返回的 POI 的入口点。

EntryPointType

入口点的类型。 值可以是main或次要值。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GeographicEntityType

Geography 实体类型。 仅在请求 entityType 且可用时显示。

Geometry

有关结果的几何形状的信息。 仅当类型 == Geography 时才存在。

JsonFormat

响应的所需格式。 仅支持 json 格式。

LatLongPairAbbreviated

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

MatchType

反向地址搜索操作的匹配类型。

OperatingHours

POI (兴趣点) 的营业时间。

OperatingHoursTime

表示日期和时间

OperatingHoursTimeRange

一天的开放时间范围

PointOfInterest

返回的 POI 的详细信息，包括姓名、电话、URL 地址和分类等信息。

PointOfInterestCategorySet

POI 类别

QueryType

返回的查询类型：NEARBY 或 NON_NEAR。

Response

查询结果。 如果查询成功完成，则 SearchAddressResult;否则为 ErrorResponse。

ReverseSearchAddressBatchItem

从搜索地址反向批处理服务调用返回的项。

ReverseSearchAddressBatchProcessResult

此对象从成功的搜索地址反向批处理服务调用中返回。

SearchAddressResultItem

搜索 API 响应的结果对象。

SearchAddressResultType

下列其中一项：

• POI
• 街道
• 地理位置
• 点地址
• 地址范围
• 十字路口

SearchSummary

搜索 API 响应的摘要对象。

Summary

批处理请求的结果摘要