Route - Get Route Operations Result

Haal het resultaat op van een asynchrone bewerking op basis van de bewerkings-id.

GET {endpoint}/route/operations/{id}/result?api-version=2025-01-01

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

De hostnaam van de Azure Maps-service. Gebruik https://atlas.microsoft.com voor de Azure publieke cloud. Om een specifieke Azure Maps geografie of een soevereine cloud te targeten, zie Azure Maps geografische reikwijdte.

id
path True

string

minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Door het systeem gegenereerde unieke id voor de asynchrone bewerking nadat deze is ingediend.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-id

string

Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke ID voor het Azure Maps-account kan worden verkregen via de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.

Accept-Language

string

Taal waarin routeringsresultaten moeten worden geretourneerd.

Voor meer informatie, zie Localization support in Azure Maps.

Antwoorden

Name Type Description
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

De aanvraag is voltooid.

404 Not Found

MapsErrorResponse

De aangevraagde resource kan niet worden gevonden op de server.

Other Status Codes

MapsErrorResponse

Een onverwachte foutreactie.

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Note

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
  • De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
  • Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
  • Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Retrieve the async matrix result

Voorbeeldaanvraag

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01

Voorbeeldrespons

{
  "type": "Feature",
  "geometry": null,
  "kind": "RouteMatrix",
  "properties": {
    "matrix": [
      {
        "arrivalAt": "2022-12-20T00:21:14+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 0,
        "distanceInMeters": 573064,
        "durationInSeconds": 27677,
        "durationTrafficInSeconds": 27677,
        "originIndex": 0,
        "statusCode": 200
      },
      {
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        },
        "originIndex": 0,
        "statusCode": 400
      },
      {
        "arrivalAt": "2022-12-19T22:19:10+01:00",
        "departureAt": "2022-12-19T16:39:57+01:00",
        "destinationIndex": 0,
        "distanceInMeters": 452488,
        "durationInSeconds": 20353,
        "durationTrafficInSeconds": 20353,
        "originIndex": 1,
        "statusCode": 200
      },
      {
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        },
        "originIndex": 1,
        "statusCode": 400
      }
    ],
    "summary": {
      "successfulCount": 2,
      "totalCount": 4
    }
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definities

Name Description
CommonErrorDetail

De foutdetails.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

FeaturesItemTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is Functie. Zie RFC 7946voor meer informatie.

MapsErrorDetail

De foutdetails.

MapsErrorResponse

Veelvoorkomende foutrespons voor Azure Maps API's om foutdetails terug te geven bij mislukte operaties.

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

RouteMatrixAsyncResponse

Hiermee geeft u de rijinstructies en aanvullende eigenschappen voor elk manoeuvreerpunt in de route leg.

RouteMatrixFeatureProperties

Eigenschappen van routematrix.

RouteMatrixItemResult

Resultaat van routematrixitem

RouteMatrixSummary

Samenvatting voor de routematrixaanvraag

RouteOperationKindEnum

Type asynchrone bewerking

CommonErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

CommonErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

FeaturesItemTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is Functie. Zie RFC 7946voor meer informatie.

Waarde Description
Feature

Hiermee geeft u het objecttype GeoJSON Functie.

MapsErrorDetail

De foutdetails.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

MapsErrorDetail[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

innererror

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

message

string

Een leesbare weergave van de fout.

target

string

Het doel van de fout.

MapsErrorResponse

Veelvoorkomende foutrespons voor Azure Maps API's om foutdetails terug te geven bij mislukte operaties.

Name Type Description
error

MapsErrorDetail

De foutdetails.

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

Name Type Description
code

string

De foutcode.

innererror

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

RouteMatrixAsyncResponse

Hiermee geeft u de rijinstructies en aanvullende eigenschappen voor elk manoeuvreerpunt in de route leg.

Name Type Description
geometry

Het geometrieobject is null

kind string:

RouteMatrix

Type asynchrone bewerking

properties

RouteMatrixFeatureProperties

Eigenschappen van routematrix.

type

FeaturesItemTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is Functie. Zie RFC 7946voor meer informatie.

RouteMatrixFeatureProperties

Eigenschappen van routematrix.

Name Type Description
matrix

RouteMatrixItemResult[]

De matrix van routeresultaten.

summary

RouteMatrixSummary

Samenvatting voor de routematrixaanvraag

RouteMatrixItemResult

Resultaat van routematrixitem

Name Type Description
arrivalAt

string (date-time)

De geschatte aankomsttijd, waarbij rekening wordt gehouden met de verkeersomstandigheden, wordt opgemaakt als een dateTime waarde die is gedefinieerd door RFC 3339, sectie 5,6. Het verwijst naar de tijdzone-offset door departAt of arrivalAt. Zo niet, dan wordt de UTC-tijd gebruikt. Als vertrekAt of aankomstAt een van die is, dan is departureAt afwezig.

departureAt

string (date-time)

De geschatte vertrektijd, waarbij rekening wordt gehouden met de verkeersomstandigheden, wordt opgemaakt als een dateTime waarde gedefinieerd door RFC 3339, sectie 5,6. Het verwijst naar de tijdzone-offset door departAt of arrivalAt. Zo niet, dan wordt de UTC-tijd gebruikt. Als vertrekBij of aankomstBij is any, dan is vertrekBij afwezig.

destinationIndex

integer (int32)

Index van het doelpunt

distanceInMeters

number (double)

Eigenschap Length In Meters

durationInSeconds

integer (int64)

Geschatte reistijd in seconden die geen vertragingen op de route bevatten vanwege verkeerscondities.

durationTrafficInSeconds

integer (int64)

De tijd die het in seconden kost om een overeenkomende TravelDistance te reizen met de huidige verkeersomstandigheden. Deze waarde wordt gegeven als traffic=live wordt doorgegeven om rekening te houden met de huidige verkeerscondities.

error

CommonErrorDetail

De foutdetails.

originIndex

integer (int32)

Index van het oorspronkelijke punt

statusCode

integer (int32)

De HTTP-statuscode van de huidige cel.

RouteMatrixSummary

Samenvatting voor de routematrixaanvraag

Name Type Description
successfulCount

integer (int32)

Aantal geslaagde routes in deze matrix.

totalCount

integer (int32)

Totaal aantal routes in deze matrix.

RouteOperationKindEnum

Type asynchrone bewerking

Waarde Description
RouteMatrix

Routematrix asynchrone taak.