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

RouteRequestRouteDirectionsBatchSync408Response interface

路线路线批处理 API

适用于:请参阅定价

路线方向批处理 API 仅使用单个 API 调用将成批的查询发送到 路线方向 API。 可以调用路由方向批处理 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 个失败

{
    "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
status

继承属性

headers

HTTP 响应标头。

request

生成此响应的请求。

属性详细信息

body

body: ErrorResponseOutput

属性值

status

status: "408"

属性值

"408"

继承属性详细信息

headers

HTTP 响应标头。

headers: RawHttpHeaders

属性值

继承自 HttpResponse.headers

request

生成此响应的请求。

request: PipelineRequest

属性值

继承自 HttpResponse.request