Поделиться через

RequestRouteMatrixSync interface

Пакет:
@azure-rest/maps-route

Методы

post(RouteRequestRouteMatrixSyncParameters)

API Post Route Matrix Sync — это запрос 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 подходит для обработки больших объемов относительно сложных запросов маршрутизации. При выполнении запроса с помощью асинхронного запроса служба возвращает код ответа 202 по URL-адресу перенаправления в поле "Расположение" заголовка ответа. Этот URL-адрес следует периодически проверять до тех пор, пока не будут доступны данные ответа или сведения об ошибках. Если параметр waitForResults в запросе имеет значение true, пользователь получит ответ 200, если запрос завершен в течение 120 секунд.

Максимальный размер матрицы для этого 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. Клиент отправляет запрос Route Matrix POST в Azure Maps

  2. Сервер ответит на одно из следующих действий:

    HTTP 202 Accepted — запрос матрицы маршрутов был принят.

    HTTP Error . Произошла ошибка при обработке запроса "Матрица маршрутов". Это может быть либо 400 недопустимый запрос, либо любой другой код состояния ошибки.

  3. Если запрос matrix Route был принят успешно, заголовок location в ответе содержит URL-адрес для скачивания результатов запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Клиент выдает запрос GET по URL-адресу скачивания, полученному на шаге 3, чтобы скачать результаты

Скачивание результатов синхронизации

При выполнении запроса POST для API синхронизации матрицы маршрутизации служба возвращает код ответа 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 — запрос матрицы успешно обработан. Текст ответа содержит все результаты.

Сведения о методе

post(RouteRequestRouteMatrixSyncParameters)

API Post Route Matrix Sync — это запрос 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 подходит для обработки больших объемов относительно сложных запросов маршрутизации. При выполнении запроса с помощью асинхронного запроса служба возвращает код ответа 202 по URL-адресу перенаправления в поле "Расположение" заголовка ответа. Этот URL-адрес следует периодически проверять до тех пор, пока не будут доступны данные ответа или сведения об ошибках. Если параметр waitForResults в запросе имеет значение true, пользователь получит ответ 200, если запрос завершен в течение 120 секунд.

Максимальный размер матрицы для этого 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. Клиент отправляет запрос Route Matrix POST в Azure Maps

  2. Сервер ответит на одно из следующих действий:

    HTTP 202 Accepted — запрос матрицы маршрутов был принят.

    HTTP Error . Произошла ошибка при обработке запроса "Матрица маршрутов". Это может быть либо 400 недопустимый запрос, либо любой другой код состояния ошибки.

  3. Если запрос matrix Route был принят успешно, заголовок location в ответе содержит URL-адрес для скачивания результатов запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Клиент выдает запрос GET по URL-адресу скачивания, полученному на шаге 3, чтобы скачать результаты

Скачивание результатов синхронизации

При выполнении запроса POST для API синхронизации матрицы маршрутизации служба возвращает код ответа 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 — запрос матрицы успешно обработан. Текст ответа содержит все результаты.

function post(options: RouteRequestRouteMatrixSyncParameters): StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>

Параметры

options
RouteRequestRouteMatrixSyncParameters

Возвращаемое значение

StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>