Remote Rendering - Get Conversion

Referens

Tjänst:: Mixed Reality

API-version:: 2021-01-01

Hämtar status för en viss konvertering.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
account_id	path	True	string (uuid)	Konto-ID för Azure Remote Rendering.
conversion_id	path	True	string	Ett ID som unikt identifierar konverteringen för det angivna kontot. ID:t är skiftlägeskänsligt, kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 256 tecken.
endpoint	path	True	string	Slutpunkten som ska användas, t.ex. https://remoterendering.eastus.mixedreality.azure.com. En lista finns på https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	DEN API-version som ska användas med HTTP-begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Svar

Name	Typ	Description
200 OK	conversion	OKEJ. Sidhuvuden MS-CV: string Retry-After: integer
401 Unauthorized		Obehörig. Auktorisering saknas eller är ogiltig. Sidhuvuden MS-CV: string WWW-Authenticate: string
403 Forbidden		Förbjuden. Auktoriseringen är otillräcklig för den angivna resursen. Sidhuvuden MS-CV: string
404 Not Found		Hittades inte. Det finns ingen konvertering med det angivna konverterings-ID:t. Sidhuvuden MS-CV: string
429 Too Many Requests		För många begäranden. Hastighetsgränsen har överskridits. Försök igen efter varaktigheten som anges i Retry-After-huvudet. Sidhuvuden MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Internt fel. Servern har påträffat ett internt fel. Ett nytt försök med begäran kan ge lyckade resultat. Sidhuvuden MS-CV: string

Säkerhet

Authorization

En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
I: header

Exempel

Get a single conversion by ID

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
  }
}

Statuskod:: 401

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

Statuskod:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuskod:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuskod:: 429

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

Statuskod:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definitioner

Name	Description
conversion	Egenskaperna för konverteringen.
conversion_input_settings	Inställningar för konverteringsindata beskriver ursprunget för konverteringsindata.
conversion_output_settings	Inställningar för konverteringsutdata beskriver målet för konverteringsutdata.
conversion_settings	Konverteringsinställningar beskriver ursprunget för indatafiler och målet för utdatafiler.
conversion_status	Status för konverteringen. Terminaltillstånden är "Cancelled", "Failed" och "Succeeded".
error	Felobjektet som innehåller information om varför begäran misslyckades.
error_response	Felsvaret innehåller information om varför begäran misslyckades.
Output	Information om utdata från en lyckad konvertering. Visas endast när statusen för konverteringen är "Lyckades".

conversion

Objekt

Egenskaperna för konverteringen.

Name	Typ	Description
creationTime	string (date-time)	Tiden då konverteringen skapades. Datum och tid i ISO 8601-format.
error	error	Felobjektet som innehåller information om konverteringsfelet.
id	string	ID:t för konverteringen som angavs när konverteringen skapades.
output	Output	Information om utdata från en lyckad konvertering. Visas endast när statusen för konverteringen är "Lyckades".
settings	conversion_settings	Konverteringsinställningar beskriver ursprunget för indatafiler och målet för utdatafiler.
status	conversion_status	Status för konverteringen. Terminaltillstånden är "Cancelled", "Failed" och "Succeeded".

conversion_input_settings

Objekt

Inställningar för konverteringsindata beskriver ursprunget för konverteringsindata.

Name	Typ	Description
blobPrefix	string	Endast blobar som börjar med det här prefixet laddas ned för att utföra konverteringen. Valfritt. Om det inte anges laddas alla blobar från containern ned.
relativeInputAssetPath	string	Den relativa sökvägen som börjar vid blobPrefix (eller vid containerroten om blobPrefix inte tillhandahålls) till indatamodellen. Måste peka på en fil med ett filformat som stöds. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas	string	En Azure Blob Storage-container med signatur för delad åtkomst som ger läs- och liståtkomst till lagringscontainern. Valfritt. Om det inte tillhandahålls måste Azure Remote Rendering-kontot länkas till lagringskontot som innehåller blobcontainern. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Av säkerhetsskäl fylls det här fältet aldrig i i svarskroppar.
storageContainerUri	string (uri)	URI:n för Azure Blob Storage-containern som innehåller indatamodellen.

conversion_output_settings

Objekt

Inställningar för konverteringsutdata beskriver målet för konverteringsutdata.

Name	Typ	Description
blobPrefix	string	Ett prefix som förbereds framför alla filer som skapas av konverteringsprocessen. Behandlas som en virtuell mapp. Valfritt. Om det inte anges lagras utdatafilerna i containerroten.
outputAssetFilename	string	Filnamnet på utdatatillgången. Måste sluta med '.arrAsset'. Valfritt. Om det inte anges kommer filnamnet att ha samma namn som indatatillgången, med tillägget ".arrAsset"
storageContainerUri	string (uri)	URI:n för Azure Blob Storage-containern där resultatet av konverteringen ska skrivas till.
storageContainerWriteSas	string	En Azure Blob Storage-container med delad åtkomstsignatur som ger skrivåtkomst till lagringscontainern. Valfritt. Om det inte tillhandahålls måste Azure Remote Rendering-kontot länkas till lagringskontot som innehåller blobcontainern. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Av säkerhetsskäl fylls det här fältet aldrig i i svarskroppar.

conversion_settings

Objekt

Konverteringsinställningar beskriver ursprunget för indatafiler och målet för utdatafiler.

Name	Typ	Description
inputLocation	conversion_input_settings	Inställningar för konverteringsindata beskriver ursprunget för konverteringsindata.
outputLocation	conversion_output_settings	Inställningar för konverteringsutdata beskriver målet för konverteringsutdata.

conversion_status

Uppräkning

Status för konverteringen. Terminaltillstånden är "Cancelled", "Failed" och "Succeeded".

Värde	Description
Cancelled	Konverteringen avbröts. Det här är ett terminaltillstånd.
Failed	Konverteringen misslyckades. Mer information finns i fältet "fel". Det här är ett terminaltillstånd.
NotStarted	Konverteringen skapades men har inte startats.
Running	Konverteringen körs.
Succeeded	Konverteringen har slutförts. Kontrollera fältet "output" för utdatatillgångens plats. Det här är ett terminaltillstånd.

error

Objekt

Felobjektet som innehåller information om varför begäran misslyckades.

Name	Typ	Description
code	string	Felkod.
details	error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innerError	error	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för det specifika felet (t.ex. namnet på egenskapen i fel).

error_response

Objekt

Felsvaret innehåller information om varför begäran misslyckades.

Name	Typ	Description
error	error	Felobjektet som innehåller information om varför begäran misslyckades.

Output

Objekt

Information om utdata från en lyckad konvertering. Visas endast när statusen för konverteringen är "Lyckades".

Name	Typ	Description
outputAssetUri	string (uri)	URI för den tillgång som genereras av konverteringsprocessen.

Dela via

Remote Rendering - Get Conversion

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Authorization

Exempel

Get a single conversion by ID

Exempelbegäran

Exempelsvar

Definitioner

conversion

conversion_input_settings

conversion_output_settings

conversion_settings

conversion_status

error

error_response

Output

Ytterligare resurser