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

RouteRequestRouteDirectionsBatchSyncDefaultResponse interface

路由方向批处理 API适用于:请参阅定价

路由方向批处理 API 只需使用单个 API 调用即可将成批查询发送到 路由方向 API 。 可以调用路由方向 Batch API 以异步 (异步运行异步) 或同步 (同步) 。 异步 API 允许调用方批处理最多 700 个查询,并同步 API 最多 100 个查询。

提交同步批处理请求

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

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

批处理响应模型

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

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

  • Error - 如果查询失败。 在本例中,响应将包含 codemessage

下面是包含 1 个 成功 和 1 个 失败 结果的示例 Batch 响应:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Extends

{ body: unknown, headers: RawHttpHeaders, request: PipelineRequest, status: string }

属性

body
status

继承属性

headers

HTTP 响应标头。

request

生成此响应的请求。

属性详细信息

body

body: ErrorResponseOutput

属性值

status

status: string

属性值

string

继承属性详细信息

headers

HTTP 响应标头。

headers: RawHttpHeaders

属性值

RawHttpHeaders

继承自__type.headers

request

生成此响应的请求。

request: PipelineRequest

属性值

PipelineRequest

继承自__type.request