你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
GetGeocodingBatch interface
方法
post(Search |
Geocoding Batch API 适用于:请参阅定价 层。 Geocoding Batch API 仅使用单个 API 调用将查询批量发送到 地理编码 API。 API 允许调用方对多达 100 个 查询进行批处理。 提交同步批处理请求建议对轻型批处理请求使用同步 API。 当服务收到请求时,它会在计算批处理项后立即做出响应,并且以后将无法检索结果。 如果请求花费的时间超过 60 秒,同步 API 将返回超时错误(408 响应)。 批项数限制为此 API 100 个。
批处理请求的 POST 正文若要发送 地理编码 查询,将使用
geocoding batchItem 对象可以接受任何受支持的 地理编码URI 参数。 批处理应至少包含 1 个 查询 批处理响应模型批处理响应包含一个
|
方法详细信息
post(SearchGetGeocodingBatchParameters)
Geocoding Batch API
适用于:请参阅定价 层。
Geocoding Batch API 仅使用单个 API 调用将查询批量发送到 地理编码 API。 API 允许调用方对多达 100 个 查询进行批处理。
提交同步批处理请求
建议对轻型批处理请求使用同步 API。 当服务收到请求时,它会在计算批处理项后立即做出响应,并且以后将无法检索结果。 如果请求花费的时间超过 60 秒,同步 API 将返回超时错误(408 响应)。 批项数限制为此 API 100 个。
POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01
批处理请求的 POST 正文
若要发送 地理编码 查询,将使用 POST
请求,其中请求正文将包含 json
格式的 batchItems
数组,Content-Type
标头将设置为 application/json
。 下面是包含 2 个 地理编码 查询的示例请求正文:
{
"batchItems": [
{
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
"top": 2
},
{
"addressLine": "Pike Pl",
"adminDistrict": "WA",
"locality": "Seattle",
"top": 3
}
]
}
geocoding batchItem 对象可以接受任何受支持的 地理编码URI 参数。
批处理应至少包含 1 个 查询
批处理响应模型
批处理响应包含一个 summary
组件,该组件指示作为原始批处理请求的一部分的 totalRequests
,successfulRequests
即已成功执行的查询。 批处理响应还包括一个 batchItems
数组,其中包含批处理请求中每个查询的响应。
batchItems
将包含结果,其顺序与在批处理请求中发送原始查询的顺序完全相同。 每个项都是以下类型之一:
GeocodingResponse
- 如果查询成功完成。Error
- 如果查询失败。 在这种情况下,响应将包含code
和message
。
function post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>