Route - Post Route Matrix Sync

使用 获取路线矩阵，使用同步请求显示出发地和目的地列表中所有可能对的行程时间和距离。

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 (它不需要是正方形) 。

异步响应将存储 14 天。 如果过期后使用重定向 URL，则返回 404 响应。

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

下面是典型的异步操作序列：

1. 客户端将路线矩阵 POST 请求发送到 Azure Maps

2. 服务器将使用以下项之一进行响应：

   HTTP 202 Accepted - 已接受路由矩阵请求。

   HTTP Error - 处理路由矩阵请求时出错。 这可能是 400 错误请求或任何其他错误状态代码。

3. 如果已成功接受矩阵路由请求，则响应中的 Location 标头包含用于下载请求结果的 URL。 此状态 URI 如下所示：

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

4. 客户端在步骤 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}

发出请求时 GET ，位置标头提供的 URL 将返回以下响应。

HTTP 202 Accepted - 矩阵请求已接受，但仍在处理中。 请稍后重试。

HTTP 200 OK - 矩阵请求已成功处理。 响应正文包含所有结果。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI 参数

请求头

请求正文

响应

安全性

AADToken

这些是 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问控制 配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。 可以通过内置角色或由 Azure Maps REST API 的一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限。

若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

• 此安全定义 需要使用x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和Microsoft Entra ID 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。 * 使用 Azure Maps Web SDK 可以基于配置设置多个用例的应用程序。

• 有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

subscription-key

这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户 时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可以用作颁发它们的帐户中的主密钥。

对于公开的应用程序，我们建议使用 机密客户端应用程序 方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源 上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 映射帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Successfully retrieve a route matrix request result synchronously

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定义

ComputeTravelTime

指定是否使用不同类型的交通信息返回其他行程时间， (无、历史、实时) 以及默认的最佳估计行程时间。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息，请参阅 RFC 7946 。

InclineLevel

惊心动魄路线的丘陵程度。 此参数只能与 routeType=thrilling 结合使用。

JsonFormat

响应的所需格式。 仅支持 json 格式。

RouteAvoidType

指定在确定路由时路由计算应尝试避免的内容。 可以在一个请求中多次指定，例如，“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中，不得使用 alreadyUsedRoads 值。

RouteLegSummary

路由节的摘要对象。

RouteMatrix

矩阵结果对象

RouteMatrixQuery

具有坐标矩阵的 对象。

RouteMatrixResult

此对象是从成功的 Route Matrix 调用返回的。 例如，如果提供了 2 个源和 3 个目标，则每个数组将包含 3 个元素的数组。 每个元素的内容取决于查询中提供的选项。

RouteMatrixResultResponse

输入矩阵中当前单元格的响应对象。

RouteMatrixSummary

Summary 对象

RouteType

请求的路由类型。

SectionType

指定在路由响应中报告哪些节类型。

例如，如果 sectionType = 行人，则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下，travelMode 设置为 car

TravelMode

所请求路线的出行模式。 如果未定义，则默认值为“car”。 请注意，请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节，则该节响应的 travelMode 元素将为“other”。 请注意，公交、摩托车、出租车和面包车的出行模式是 BETA 版功能。 并非所有区域都提供完全限制数据。

VehicleLoadType

可归类为危险品并限制在一些道路的货物类型。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，外加在其他国家/地区使用的泛型分类。 以 USHazmat 开头的值用于美国路由，而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。

WindingnessLevel

惊心动魄路线的转弯水平。 此参数只能与 routeType=thrilling 结合使用。