다음을 통해 공유


@azure-rest/maps-route package

인터페이스

BatchRequest

이 형식은 Batch 서비스에 대한 요청 본문을 나타냅니다.

BatchRequestItem

Batch 요청 개체

BatchResultItemOutput

Batch API에서 반환된 항목입니다. 'response' 속성을 사용하여 확장합니다.

BatchResultOutput

이 개체는 성공적인 Batch 서비스 호출에서 반환됩니다. 'batchItems' 속성으로 확장합니다.

BatchResultSummaryOutput

일괄 처리 요청에 대한 결과 요약

EffectiveSettingOutput

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

ErrorDetailOutput

오류 세부 정보입니다.

ErrorResponseOutput

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

GeoJsonFeature

유효한 GeoJSON Feature 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonFeatureCollection

유효한 GeoJSON FeatureCollection 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

유효한 GeoJSON GeometryCollection 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonGeometryCollectionData
GeoJsonGeometryParent

유효한 GeoJSON 기하 도형 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonLineString

유효한 GeoJSON LineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonLineStringData
GeoJsonMultiLineString

유효한 GeoJSON MultiLineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonMultiLineStringData
GeoJsonMultiPoint

유효한 GeoJSON MultiPoint 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonMultiPointData

GeoJson MultiPoint포함된 데이터입니다.

GeoJsonMultiPolygon

유효한 GeoJSON MultiPolygon 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonMultiPolygonData
GeoJsonObjectParent

유효한 GeoJSON 개체입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonPointData

GeoJson Point포함된 데이터입니다.

GeoJsonPolygon

유효한 GeoJSON Polygon 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

위도 및 경도로 표시되는 위치입니다.

MapsRouteClientOptions

클라이언트에 대한 선택적 매개 변수

RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

경로 방향에 대한 본문 매개 변수를 게시합니다.

RouteDirectionsBatchItemOutput

Route Directions Batch 서비스 호출에서 반환된 항목입니다.

RouteDirectionsBatchItemResponseOutput

쿼리의 결과입니다. 쿼리가 성공적으로 완료되면 RouteDirections, 그렇지 않으면 ErrorResponse입니다.

RouteDirectionsBatchResultOutput

이 개체는 성공적인 Route Directions Batch 서비스 호출에서 반환됩니다.

RouteDirectionsOutput

이 개체는 성공적인 경로 방향 호출에서 반환됩니다.

RouteGetRouteDirections200Response

Get Route Directions API는 지정된 경우 중간 지점을 통과하여 원본과 대상 간의 경로를 반환하는 HTTP GET 요청입니다. 이 경로는 현재 교통량과 요청된 요일 및 시간에 대한 일반적인 도로 속도와 같은 요인을 고려합니다.

반환되는 정보에는 거리, 예상 이동 시간 및 경로 기하 도형의 표현이 포함됩니다. 선택한 옵션에 따라 최적화된 웨이포인트 순서 또는 순서별 순서와 같은 추가 라우팅 정보도 사용할 수 있습니다.

라우팅 서비스는 차량별 소비 모델에 대한 자세한 설명을 위한 매개 변수 집합을 제공합니다. 자세한 내용은 소비 모델참조하세요.

RouteGetRouteDirectionsBatch200Response

Get Route Directions Batch API는 단일 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP GET 요청입니다. Get Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 다운로드 엔드포인트에 GET 요청을 실행합니다. 이 다운로드 URL 성공적인 Location 일괄 처리 요청의 POST 헤더에서 가져올 수 있으며 다음과 같습니다.

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

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 GET사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Get Route Directions Batch API는 단일 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP GET 요청입니다. Get Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 다운로드 엔드포인트에 GET 요청을 실행합니다. 이 다운로드 URL 성공적인 Location 일괄 처리 요청의 POST 헤더에서 가져올 수 있으며 다음과 같습니다.

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

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 GET사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

Get Route Directions API는 지정된 경우 중간 지점을 통과하여 원본과 대상 간의 경로를 반환하는 HTTP GET 요청입니다. 이 경로는 현재 교통량과 요청된 요일 및 시간에 대한 일반적인 도로 속도와 같은 요인을 고려합니다.

반환되는 정보에는 거리, 예상 이동 시간 및 경로 기하 도형의 표현이 포함됩니다. 선택한 옵션에 따라 최적화된 웨이포인트 순서 또는 순서별 순서와 같은 추가 라우팅 정보도 사용할 수 있습니다.

라우팅 서비스는 차량별 소비 모델에 대한 자세한 설명을 위한 매개 변수 집합을 제공합니다. 자세한 내용은 소비 모델참조하세요.

RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Post Route Directions API는 지정된 경우 중간 지점을 통과하여 원본과 대상 사이의 경로를 반환하는 HTTP POST 요청입니다. 이 경로는 요청된 요일 및 시간에 대한 현재 교통량 및 일반적인 도로 속도와 같은 요인을 고려합니다.

반환되는 정보에는 거리, 예상 이동 시간 및 경로 기하 도형의 표현이 포함됩니다. 선택한 옵션에 따라 최적화된 웨이포인트 순서 또는 순서별 순서와 같은 추가 라우팅 정보도 사용할 수 있습니다.

라우팅 서비스는 차량별 소비 모델에 대한 자세한 설명을 위한 매개 변수 집합을 제공합니다. 관련된 개념 및 매개 변수에 대한 자세한 설명은 소비 모델 확인하세요.

RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Post Route Directions API는 지정된 경우 중간 지점을 통과하여 원본과 대상 사이의 경로를 반환하는 HTTP POST 요청입니다. 이 경로는 요청된 요일 및 시간에 대한 현재 교통량 및 일반적인 도로 속도와 같은 요인을 고려합니다.

반환되는 정보에는 거리, 예상 이동 시간 및 경로 기하 도형의 표현이 포함됩니다. 선택한 옵션에 따라 최적화된 웨이포인트 순서 또는 순서별 순서와 같은 추가 라우팅 정보도 사용할 수 있습니다.

라우팅 서비스는 차량별 소비 모델에 대한 자세한 설명을 위한 매개 변수 집합을 제공합니다. 관련된 개념 및 매개 변수에 대한 자세한 설명은 소비 모델 확인하세요.

RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Get Route Matrix API는 원본 및 대상 목록에서 가능한 모든 쌍의 이동 시간과 거리를 계산하는 HTTP GET 요청입니다. 자세한 경로 지침을 제공하는 경로 방향 가져오기 API와 달리, 이 API는 각 출발지에서 모든 목적지로 라우팅하는 비용(이동 시간 및 거리)을 제공하여 효율성에 중점을 둡니다. 자세한 내용은 Azure Maps Route 서비스대한 모범 사례를 참조하세요.

지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 Route Matrix GET 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 GET 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Get Route Matrix API는 원본 및 대상 목록에서 가능한 모든 쌍의 이동 시간과 거리를 계산하는 HTTP GET 요청입니다. 자세한 경로 지침을 제공하는 경로 방향 가져오기 API와 달리, 이 API는 각 출발지에서 모든 목적지로 라우팅하는 비용(이동 시간 및 거리)을 제공하여 효율성에 중점을 둡니다. 자세한 내용은 Azure Maps Route 서비스대한 모범 사례를 참조하세요.

지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 Route Matrix GET 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 GET 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteGetRouteRange200Response

Get Route Range(Isochrone) API는 지정된 연료, 에너지, 시간 또는 거리 예산에 따라 원점에서 도달할 수 있는 위치 집합을 계산하는 HTTP GET 요청입니다. 다각형 경계(또는 등시선)는 원점의 결과인 정확한 다각형 중심뿐만 아니라 시계 반대 방향으로 반환됩니다.

반환된 다각형은 제공된 등시선 내에서 POI를 검색하기 위해 내부 기하 도형 검색과 같은 추가 처리에 사용할 수 있습니다.

RouteGetRouteRangeDefaultResponse

Get Route Range(Isochrone) API는 지정된 연료, 에너지, 시간 또는 거리 예산에 따라 원점에서 도달할 수 있는 위치 집합을 계산하는 HTTP GET 요청입니다. 다각형 경계(또는 등시선)는 원점의 결과인 정확한 다각형 중심뿐만 아니라 시계 반대 방향으로 반환됩니다.

반환된 다각형은 제공된 등시선 내에서 POI를 검색하기 위해 내부 기하 도형 검색과 같은 추가 처리에 사용할 수 있습니다.

RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

관련 지침 요소를 포함합니다. 이 필드는 지침이 요청되어 사용할 수 있는 경우에만 존재합니다.

RouteInstructionGroupOutput

서로 관련된 명령 요소의 시퀀스를 그룹화합니다. 시퀀스 범위는 firstInstructionIndex 및 lastInstructionIndex로 제한됩니다. 사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하면 instructionGroup에는 사용 가능한 경우 반환되는 요약 메시지가 있습니다.

RouteInstructionOutput

기동을 설명하는 특성 집합(예: '오른쪽으로 돌기', '왼쪽 유지', '페리 타기', '고속도로 이용', '도착')

RouteLegOutput

점 목록으로 구성된 경로의 일부에 대한 설명입니다. 요청에 제공된 각 추가 중간 지점은 반환된 경로에 추가 레그를 생성합니다.

RouteMatrixOutput

행렬 결과 개체

RouteMatrixQuery

좌표 행렬이 있는 개체입니다.

RouteMatrixResultOutput

이 개체는 성공적인 Route Matrix 호출에서 반환됩니다. 예를 들어 2개의 원본과 3개의 대상이 제공되면 각각 3개의 요소가 있는 2개의 배열이 있습니다. 각 요소의 콘텐츠는 쿼리에 제공된 옵션에 따라 달라집니다.

RouteMatrixResultResponseOutput

입력 행렬에 있는 현재 셀의 응답 개체입니다.

RouteMatrixSummaryOutput

요약 개체

RouteOptimizedWaypointOutput

최적화된 방법 지점 개체입니다.

RouteOutput
RouteRangeOutput

도달 가능한 범위

RouteRangeResultOutput

이 개체는 경로 연결 가능 범위 호출에서 반환됩니다.

RouteReportOutput

현재 호출에 사용된 유효 설정을 보고합니다.

RouteRequestRouteDirectionsBatch200Response

Post Route Directions Batch API는 단일 비동기 요청을 사용하여 POST API에 쿼리 일괄 처리를 보내는 HTTP 요청입니다. Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다. 동기 요청에서 API를 호출하려면 경로 방향 일괄 처리 동기화참조하세요.

비동기 일괄 처리 요청 제출

비동기 API는 비교적 복잡한 경로 요청의 큰 볼륨을 처리하는 데 적합합니다.

  • 별도의 호출로 결과를 검색할 수 있습니다(여러 다운로드 가능).
  • 비동기 API는 안정성에 최적화되어 있으며 시간 제한으로 실행되지 않을 것으로 예상됩니다.
  • 일괄 처리 항목 수는 이 API에 대한 700 제한됩니다.

비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

비동기 일괄 처리 요청은 장기 실행 작업입니다. 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 경로 방향 일괄 처리 POST 요청을 Azure Maps에 보냅니다.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었습니다.

    HTTP Error - Batch 요청을 처리하는 동안 오류가 발생했습니다. 400 Bad Request 또는 다른 Error 상태 코드일 수 있습니다.

  2. 일괄 처리 요청이 성공적으로 수락된 경우 응답의 Location 헤더에는 일괄 처리 요청의 결과를 다운로드하는 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 클라이언트는 3단계에서 가져온 GET 요청을 실행하여 일괄 처리 결과를 다운로드합니다.

Batch 요청에 대한 POST 본문

쿼리를 경로 방향을 보내려면 요청 본문에 배열이 형식으로 포함되고 헤더가 설정되는 요청을 사용합니다. 다음은 쿼리에 3개의 경로 방향을 포함하는 샘플 요청 본문입니다.

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

일괄 처리에서 쿼리를 경로 방향은 프로토콜, 기본 URL, 경로, api-version 및 subscription-key를 않고 부분 URL . 지원되는 경로 방향URI 매개 변수수락할 수 있습니다. 쿼리에 경로 방향의 문자열 값은 제대로 이스케이프되어야 하며(예: " 문자는 \로 이스케이프되어야 함) URL로 인코딩되어야 합니다.

비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 API를 최대 100개의 쿼리를 동기화할 수 있으며, 일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 다운로드 엔드포인트에 GET 요청을 실행합니다. 이 다운로드 URL 성공적인 Location 일괄 처리 요청의 POST 헤더에서 가져올 수 있으며 다음과 같습니다.

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

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 GET사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

Post Route Directions Batch API는 단일 비동기 요청을 사용하여 POST API에 쿼리 일괄 처리를 보내는 HTTP 요청입니다. Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다. 동기 요청에서 API를 호출하려면 경로 방향 일괄 처리 동기화참조하세요.

비동기 일괄 처리 요청 제출

비동기 API는 비교적 복잡한 경로 요청의 큰 볼륨을 처리하는 데 적합합니다.

  • 별도의 호출로 결과를 검색할 수 있습니다(여러 다운로드 가능).
  • 비동기 API는 안정성에 최적화되어 있으며 시간 제한으로 실행되지 않을 것으로 예상됩니다.
  • 일괄 처리 항목 수는 이 API에 대한 700 제한됩니다.

비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

비동기 일괄 처리 요청은 장기 실행 작업입니다. 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 경로 방향 일괄 처리 POST 요청을 Azure Maps에 보냅니다.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
  1. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었습니다.

    HTTP Error - Batch 요청을 처리하는 동안 오류가 발생했습니다. 400 Bad Request 또는 다른 Error 상태 코드일 수 있습니다.

  2. 일괄 처리 요청이 성공적으로 수락된 경우 응답의 Location 헤더에는 일괄 처리 요청의 결과를 다운로드하는 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. 클라이언트는 3단계에서 가져온 GET 요청을 실행하여 일괄 처리 결과를 다운로드합니다.

Batch 요청에 대한 POST 본문

쿼리를 경로 방향을 보내려면 요청 본문에 배열이 형식으로 포함되고 헤더가 설정되는 요청을 사용합니다. 다음은 쿼리에 3개의 경로 방향을 포함하는 샘플 요청 본문입니다.

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

일괄 처리에서 쿼리를 경로 방향은 프로토콜, 기본 URL, 경로, api-version 및 subscription-key를 않고 부분 URL . 지원되는 경로 방향URI 매개 변수수락할 수 있습니다. 쿼리에 경로 방향의 문자열 값은 제대로 이스케이프되어야 하며(예: " 문자는 \로 이스케이프되어야 함) URL로 인코딩되어야 합니다.

비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 API를 최대 100개의 쿼리를 동기화할 수 있으며, 일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

비동기 일괄 처리 결과 다운로드

비동기 일괄 처리 결과를 다운로드하려면 일괄 다운로드 엔드포인트에 GET 요청을 실행합니다. 이 다운로드 URL 성공적인 Location 일괄 처리 요청의 POST 헤더에서 가져올 수 있으며 다음과 같습니다.

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

일괄 처리 결과를 다운로드하기 위한 일반적인 작업 시퀀스는 다음과 같습니다.

  1. 클라이언트는 GET사용하여 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - Batch 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

    HTTP 200 OK - 일괄 처리 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 일괄 처리 결과가 포함됩니다.

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Post Route Directions Batch Sync API는 단일 동기 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다. Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다. 비동기 요청에서 API를 호출하려면 경로 방향 일괄 처리참조하세요.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

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

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Post Route Directions Batch Sync API는 단일 동기 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다. Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다. 비동기 요청에서 API를 호출하려면 경로 방향 일괄 처리참조하세요.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

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

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Post Route Directions Batch Sync API는 단일 동기 요청을 사용하여 경로 방향 가져오기 API에 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다. Route Directions Batch API를 호출하여 비동기(비동기) 또는 동기(동기화)를 실행할 수 있습니다. 비동기 API를 사용하면 호출자가 최대 700개의 쿼리를 일괄 처리하고 최대 100개의 쿼리까지 API를 동기화할 수 있습니다. 비동기 요청에서 API를 호출하려면 경로 방향 일괄 처리참조하세요.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

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

Batch 응답 모델

반환된 데이터 콘텐츠는 비동기 및 동기화 요청과 유사합니다. 비동기 일괄 처리 요청의 결과를 다운로드할 때 일괄 처리가 완료되면 응답 본문에 일괄 처리 응답이 포함됩니다. 이 일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. batchItems 각 항목에는 statusCoderesponse 필드가 포함됩니다. responsebatchItems 다음 유형 중 하나입니다.

  • RouteDirections - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

다음은 성공적인 11 실패한 일괄 처리 응답 샘플입니다.

{
    "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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Post Route Matrix API는 비동기(비동기) 요청을 사용하여 원본 및 대상 위치에 정의된 경로 집합에 대한 경로 요약 행렬을 계산할 수 있는 HTTP POST 요청입니다. 동기(동기화) 요청을 만들려면 경로 매트릭스 동기화참조하세요. 지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

참고

모든 출발지와 목적지는 축 맞춤 400km x 400km 경계 상자에 포함되어야 합니다. 그렇지 않으면 일부 행렬 셀이 OUT_OF_REGION 확인됩니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

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

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 경로 매트릭스 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 POST 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Post Route Matrix API는 비동기(비동기) 요청을 사용하여 원본 및 대상 위치에 정의된 경로 집합에 대한 경로 요약 행렬을 계산할 수 있는 HTTP POST 요청입니다. 동기(동기화) 요청을 만들려면 경로 매트릭스 동기화참조하세요. 지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

참고

모든 출발지와 목적지는 축 맞춤 400km x 400km 경계 상자에 포함되어야 합니다. 그렇지 않으면 일부 행렬 셀이 OUT_OF_REGION 확인됩니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

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

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 경로 매트릭스 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 POST 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Post Route Matrix Sync API는 단일 동기(동기화) 요청을 사용하여 원본 및 대상 위치에 정의된 경로 집합에 대한 경로 요약 행렬을 계산할 수 있는 HTTP POST 요청입니다. 비동기(비동기) 요청을 만들려면 경로 행렬참조하세요. 지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

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

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 경로 매트릭스 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 POST 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteRequestRouteMatrixSync408Response

Post Route Matrix Sync API는 단일 동기(동기화) 요청을 사용하여 원본 및 대상 위치에 정의된 경로 집합에 대한 경로 요약 행렬을 계산할 수 있는 HTTP POST 요청입니다. 비동기(비동기) 요청을 만들려면 경로 행렬참조하세요. 지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

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

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 경로 매트릭스 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 POST 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Post Route Matrix Sync API는 단일 동기(동기화) 요청을 사용하여 원본 및 대상 위치에 정의된 경로 집합에 대한 경로 요약 행렬을 계산할 수 있는 HTTP POST 요청입니다. 비동기(비동기) 요청을 만들려면 경로 행렬참조하세요. 지정된 모든 원본에 대해 서비스는 해당 원본에서 지정된 모든 대상으로 라우팅하는 비용을 계산합니다. 원본 집합 및 대상 집합은 테이블의 열 및 행 머리글로 간주할 수 있으며 테이블의 각 셀에는 원본에서 해당 셀의 대상으로 라우팅하는 비용이 포함됩니다. 예를 들어 음식 배달 회사에는 20명의 운전자가 있으며 식당에서 배달을 받을 가장 가까운 드라이버를 찾아야 한다고 가정해 보겠습니다. 이 사용 사례를 해결하기 위해 행렬 경로 API를 호출할 수 있습니다.

각 경로에 대해 이동 시간 및 거리가 반환됩니다. 계산 비용을 사용하여 경로 방향 API를 사용하여 계산할 자세한 경로를 결정할 수 있습니다.

비동기 요청에 대한 행렬의 최대 크기는 700 동기화 요청의 경우 100(원본 수에 대상 수를 곱한 값)입니다.

동기 경로 매트릭스 요청 제출

시나리오에 동기 요청이 필요하고 행렬의 최대 크기가 100보다 작거나 같은 경우 동기 요청을 수행할 수 있습니다. 이 API에 대한 행렬의 최대 크기는 100(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 10x10, 6x8, 9x8입니다(정사각형일 필요는 없음).

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

비동기 경로 매트릭스 요청 제출

비동기 API는 비교적 복잡한 라우팅 요청의 큰 볼륨을 처리하는 데 적합합니다. 비동기 요청을 사용하여 요청을 수행하면 기본적으로 서비스는 응답 헤더의 위치 필드에 있는 리디렉션 URL을 따라 202 응답 코드를 반환합니다. 이 URL은 응답 데이터 또는 오류 정보를 사용할 수 있을 때까지 주기적으로 확인해야 합니다. 요청의 waitForResults 매개 변수가 true로 설정된 경우 요청이 120초 미만으로 완료되면 사용자에게 200 응답이 표시됩니다.

이 API에 대한 행렬의 최대 크기는 700(원본 수에 대상 수를 곱한 값)입니다. 이러한 제약 조건을 염두에 두고 가능한 행렬 차원의 예는 50x10, 10x10, 28x25입니다. 10x70(정사각형일 필요는 없음).

비동기 응답은 24시간 동안 저장됩니다. 리디렉션 URL은 만료 기간 이후에 사용되는 경우 404 응답을 반환합니다.

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

다음은 일반적인 비동기 작업 시퀀스입니다.

  1. 클라이언트가 Azure Maps에 경로 매트릭스 POST 요청을 보냅니다.

  2. 서버는 다음 중 하나로 응답합니다.

    HTTP 202 Accepted - 경로 매트릭스 요청이 수락되었습니다.

    HTTP Error - Route Matrix 요청을 처리하는 동안 오류가 발생했습니다. 400 잘못된 요청 또는 기타 오류 상태 코드일 수 있습니다.

  3. 행렬 경로 요청이 성공적으로 수락된 경우 응답의 위치 헤더에는 요청 결과를 다운로드할 URL이 포함됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 클라이언트가 3단계에서 가져온 다운로드 URL에 대해 GET 요청을 실행하여 결과를 다운로드합니다.

동기화 결과 다운로드

경로 매트릭스 동기화 API에 대한 POST 요청을 수행하면 서비스는 성공적인 요청 및 응답 배열에 대해 200개의 응답 코드를 반환합니다. 응답 본문에는 데이터가 포함되며 나중에 결과를 검색할 가능성이 없습니다.

비동기 결과 다운로드

요청이 202 Accepted 응답을 발급하면 비동기 파이프라인을 사용하여 요청이 처리됩니다. 응답의 위치 헤더에서 비동기 요청의 진행률을 확인하는 URL이 제공됩니다. 이 상태 URI는 다음과 같습니다.

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

위치 헤더에서 제공하는 URL은 GET 요청이 실행될 때 다음 응답을 반환합니다.

HTTP 202 Accepted - 행렬 요청이 수락되었지만 여전히 처리 중입니다. 잠시 후 다시 시도하세요.

HTTP 200 OK - 행렬 요청이 성공적으로 처리되었습니다. 응답 본문에는 모든 결과가 포함됩니다.

RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

경로 섹션에는 경로의 일부에 대한 추가 정보가 포함되어 있습니다. 각 섹션에는 startPointIndex, endPointIndexsectionType요소 이상이 포함되어 있습니다.

RouteSectionTecCauseOutput

트래픽 이벤트의 원인입니다. mainCauseCode 및 subCauseCode 요소를 포함할 수 있습니다. 아이콘 및 설명을 정의하는 데 사용할 수 있습니다.

RouteSectionTecOutput

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.

RouteSummaryOutput

요약 개체

Routes
SimplePollerLike

장기 실행 작업을 폴링하는 데 사용할 수 있는 간단한 폴러입니다.

형식 별칭

GeoJsonGeometry

유효한 GeoJSON 기하 도형 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 참조하세요.

GeoJsonObject

유효한 GeoJSON 개체입니다. 자세한 내용은 RFC 7946 참조하세요.

MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

함수

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

수많은 경로 방향 요청의 일괄 처리 요청 본문을 만듭니다.

default(AzureKeyCredential, ClientOptions)

구독 키에서 MapsRouteClient 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Azure ID TokenCredentialMapsRoute 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Azure ID AzureSASCredentialMapsRoute 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

장기 실행 작업을 폴링하는 데 도움이 되는 Poller 개체를 빌드하는 도우미 함수입니다.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

[위도, Longtitute]의 배열을 "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..." 형식의 문자열로 변환합니다.

함수 세부 정보

buildMultiCollection(string[], string)

function buildMultiCollection(items: string[], parameterName: string): string

매개 변수

items

string[]

parameterName

string

반환

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

수많은 경로 방향 요청의 일괄 처리 요청 본문을 만듭니다.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

매개 변수

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

경로 방향 요청에 대한 쿼리 매개 변수의 개체입니다.

반환

구성된 일괄 처리 요청입니다.

default(AzureKeyCredential, ClientOptions)

구독 키에서 MapsRouteClient 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

매개 변수

credential
AzureKeyCredential

서비스에 대한 요청을 인증하는 데 사용되는 AzureKeyCredential 인스턴스

options
ClientOptions

경로 클라이언트를 구성하는 데 사용되는 옵션

반환

default(TokenCredential, string, ClientOptions)

Azure ID TokenCredentialMapsRoute 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

매개 변수

credential
TokenCredential

서비스에 대한 요청을 인증하는 데 사용되는 TokenCredential 인스턴스

mapsAccountClientId

string

특정 맵 리소스의 Azure Maps 클라이언트 ID

options
ClientOptions

경로 클라이언트를 구성하는 데 사용되는 옵션

반환

default(AzureSASCredential, ClientOptions)

Azure ID AzureSASCredentialMapsRoute 인스턴스를 만듭니다.

예제

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

매개 변수

credential
AzureSASCredential

서비스에 대한 요청을 인증하는 데 사용되는 AzureSASCredential 인스턴스

options
ClientOptions

경로 클라이언트를 구성하는 데 사용되는 옵션

반환

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

장기 실행 작업을 폴링하는 데 도움이 되는 Poller 개체를 빌드하는 도우미 함수입니다.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

매개 변수

client
Client

추가 페이지를 가져오기 위해 요청을 보내는 데 사용할 클라이언트입니다.

initialResponse

TResult

초기 응답입니다.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

다시 시작 상태 또는 사용자 지정 폴링 간격을 설정하는 옵션입니다.

반환

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • 작업 상태 업데이트를 폴링하고 최종 응답을 가져올 폴러 개체입니다.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

매개 변수

반환

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

매개 변수

반환

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

매개 변수

반환

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

매개 변수

반환

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

매개 변수

반환

response

toColonDelimitedLatLonString(LatLon[])

[위도, Longtitute]의 배열을 "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..." 형식의 문자열로 변환합니다.

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

매개 변수

coordinates

LatLon[]

변환할 위도/롱티투트 쌍의 배열입니다.

반환

string

변환된 문자열입니다.