Remote Rendering - Get Conversion

Referentie

Service:: Mixed Reality

API-versie:: 2021-01-01

Hiermee haalt u de status van een bepaalde conversie op.

GET {endpoint}/accounts/{account_id}/conversions/{conversion_id}?api-version=2021-01-01

URI-parameters

Name	In	Vereist	Type	Description
account_id	path	True	string (uuid)	De account-id van Azure Remote Rendering.
conversion_id	path	True	string	Een id waarmee de conversie voor het opgegeven account uniek wordt geïdentificeerd. De id is hoofdlettergevoelig, kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens en mag niet meer dan 256 tekens bevatten.
endpoint	path	True	string	Het eindpunt dat moet worden gebruikt, bijvoorbeeld https://remoterendering.eastus.mixedreality.azure.com. Een lijst is te vinden op https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Antwoorden

Name	Type	Description
200 OK	conversion	OK. Kopteksten MS-CV: string Retry-After: integer
401 Unauthorized		Ongeoorloofd. Ontbrekende of ongeldige autorisatie. Kopteksten MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboden. Autorisatie is onvoldoende voor de gegeven resource. Kopteksten MS-CV: string
404 Not Found		Niet gevonden. Er bestaat geen conversie met de opgegeven conversie-id. Kopteksten MS-CV: string
429 Too Many Requests		Te veel aanvragen. De frequentielimiet is overschreden. Voer de aanvraag opnieuw uit na de duur die is opgegeven in de Retry-After header. Kopteksten MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interne fout. Er is een interne fout opgetreden in de server. Het opnieuw proberen van de aanvraag kan resultaten opleveren. Kopteksten MS-CV: string

Beveiliging

Authorization

Een bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Type: apiKey
In: header

Voorbeelden

Get a single conversion by ID

Voorbeeldaanvraag

HTTP

GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/conversions/contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e?api-version=2021-01-01

Voorbeeldrespons

Statuscode:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
  "creationTime": "2021-01-01T11:11:11.111Z",
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  },
  "status": "Succeeded",
  "error": null,
  "output": {
    "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset"
  }
}

Statuscode:: 401

WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 429

Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definities

Name	Description
conversion	De eigenschappen van de conversie.
conversion_input_settings	De invoerinstellingen voor conversie beschrijven de oorsprong van conversie-invoer.
conversion_output_settings	De uitvoerinstellingen voor conversie beschrijven het doel van de conversie-uitvoer.
conversion_settings	Conversie-instellingen beschrijven de oorsprong van invoerbestanden en het doel van uitvoerbestanden.
conversion_status	De status van de conversie. Terminalstatussen zijn 'Geannuleerd', 'Mislukt' en 'Geslaagd'.
error	Het foutobject met details van de reden waarom de aanvraag is mislukt.
error_response	Het foutbericht met details van de reden waarom de aanvraag is mislukt.
Output	Informatie over de uitvoer van een geslaagde conversie. Alleen aanwezig wanneer de status van de conversie 'Geslaagd' is.

conversion

Object

De eigenschappen van de conversie.

Name	Type	Description
creationTime	string (date-time)	Het tijdstip waarop de conversie is gemaakt. Datum en tijd in ISO 8601-indeling.
error	error	Het foutobject met details over de conversiefout.
id	string	De id van de conversie die is opgegeven toen de conversie werd gemaakt.
output	Output	Informatie over de uitvoer van een geslaagde conversie. Alleen aanwezig wanneer de status van de conversie 'Geslaagd' is.
settings	conversion_settings	Conversie-instellingen beschrijven de oorsprong van invoerbestanden en het doel van uitvoerbestanden.
status	conversion_status	De status van de conversie. Terminalstatussen zijn 'Geannuleerd', 'Mislukt' en 'Geslaagd'.

conversion_input_settings

Object

De invoerinstellingen voor conversie beschrijven de oorsprong van conversie-invoer.

Name	Type	Description
blobPrefix	string	Alleen Blobs die met dit voorvoegsel beginnen, worden gedownload om de conversie uit te voeren. Facultatief. Indien niet opgegeven, worden alle blobs uit de container gedownload.
relativeInputAssetPath	string	Het relatieve pad dat begint bij blobPrefix (of in de containerhoofdmap als blobPrefix niet is opgegeven) aan het invoermodel. Moet verwijzen naar een bestand met een ondersteunde bestandsindeling die eindigt. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion voor meer informatie.
storageContainerReadListSas	string	Een Gedeelde toegangshandtekening voor Een Azure Blob Storage-container die lees- en lijsttoegang tot de opslagcontainer geeft. Facultatief. Als dit niet is opgegeven, moet het Azure Remote Rendering-account worden gekoppeld aan het opslagaccount dat de blobcontainer bevat. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts voor meer informatie. Voor beveiligingsdoeleinden wordt dit veld nooit ingevuld in antwoordteksten.
storageContainerUri	string (uri)	De URI van de Azure Blob Storage-container die het invoermodel bevat.

conversion_output_settings

Object

De uitvoerinstellingen voor conversie beschrijven het doel van de conversie-uitvoer.

Name	Type	Description
blobPrefix	string	Een voorvoegsel dat wordt voorafgegaan door alle bestanden die door het conversieproces worden geproduceerd. Wordt behandeld als een virtuele map. Facultatief. Indien niet opgegeven, worden uitvoerbestanden opgeslagen in de hoofdmap van de container.
outputAssetFilename	string	De bestandsnaam van de uitvoerasset. Moet eindigen op .arrAsset. Facultatief. Als deze niet is opgegeven, krijgt de bestandsnaam dezelfde naam als de invoerasset, met de extensie .arrAsset
storageContainerUri	string (uri)	De URI van de Azure Blob Storage-container waarnaar het resultaat van de conversie moet worden geschreven.
storageContainerWriteSas	string	Een Gedeelde toegangshandtekening voor Een Azure Blob Storage-container die schrijftoegang geeft tot de opslagcontainer. Facultatief. Als dit niet is opgegeven, moet het Azure Remote Rendering-account worden gekoppeld aan het opslagaccount dat de blobcontainer bevat. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts voor meer informatie. Voor beveiligingsdoeleinden wordt dit veld nooit ingevuld in antwoordteksten.

conversion_settings

Object

Conversie-instellingen beschrijven de oorsprong van invoerbestanden en het doel van uitvoerbestanden.

Name	Type	Description
inputLocation	conversion_input_settings	De invoerinstellingen voor conversie beschrijven de oorsprong van conversie-invoer.
outputLocation	conversion_output_settings	De uitvoerinstellingen voor conversie beschrijven het doel van de conversie-uitvoer.

conversion_status

Inventarisatie

De status van de conversie. Terminalstatussen zijn 'Geannuleerd', 'Mislukt' en 'Geslaagd'.

Waarde	Description
Cancelled	De conversie is geannuleerd. Dit is een terminalstatus.
Failed	De conversie is mislukt. Controleer het veld 'fout' voor meer informatie. Dit is een terminalstatus.
NotStarted	De conversie is gemaakt, maar is niet gestart.
Running	De conversie wordt uitgevoerd.
Succeeded	De conversie is geslaagd. Controleer het veld 'uitvoer' op de locatie van de uitvoerasset. Dit is een terminalstatus.

error

Object

Het foutobject met details van de reden waarom de aanvraag is mislukt.

Name	Type	Description
code	string	Foutcode.
details	error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innerError	error	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 specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

error_response

Object

Het foutbericht met details van de reden waarom de aanvraag is mislukt.

Name	Type	Description
error	error	Het foutobject met details van de reden waarom de aanvraag is mislukt.

Output

Object

Informatie over de uitvoer van een geslaagde conversie. Alleen aanwezig wanneer de status van de conversie 'Geslaagd' is.

Name	Type	Description
outputAssetUri	string (uri)	URI van de asset die wordt gegenereerd door het conversieproces.

Delen via

Remote Rendering - Get Conversion

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Authorization

Voorbeelden

Get a single conversion by ID

Voorbeeldaanvraag

Voorbeeldrespons

Definities

conversion

conversion_input_settings

conversion_output_settings

conversion_settings

conversion_status

error

error_response

Output

Aanvullende resources