次の方法で共有

RouteRequestRouteDirectionsBatchSync200Response interface

  • リファレンス
パッケージ:
@azure-rest/maps-route

ルート案内 Batch API

適用対象: 価格 レベルに関するページを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して 、Route Directions API にクエリのバッチを送信します。 Route Directions 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含まれています。 のbatchItemsそれぞれresponseは、次のいずれかの種類です。

  • RouteDirections - クエリが正常に完了した場合。

  • Error - クエリが失敗した場合。 この場合、応答には と がmessage含まれますcode。

成功した結果が 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
HttpResponse

プロパティ

body
status

継承されたプロパティ

headers

HTTP 応答ヘッダー。
request

この応答を生成した要求。

プロパティの詳細

body 

body: RouteDirectionsBatchResultOutput

プロパティ値

RouteDirectionsBatchResultOutput

status 

status: "200"

プロパティ値

"200"

継承されたプロパティの詳細

headers

HTTP 応答ヘッダー。

headers: RawHttpHeaders

プロパティ値

RawHttpHeaders

継承元 HttpResponse.headers

request

この応答を生成した要求。

request: PipelineRequest

プロパティ値

PipelineRequest

継承元 HttpResponse.request