Remote Rendering - Get Conversion

Reference

Služba:: Mixed Reality

Verze rozhraní API:: 2021-01-01

Získá stav konkrétního převodu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
account_id	path	True	string uuid	ID účtu Azure Remote Rendering.
conversion_id	path	True	string	ID jednoznačně identifikující převod pro daný účet. V ID se rozlišují velká a malá písmena, může obsahovat libovolnou kombinaci alfanumerických znaků, včetně spojovníků a podtržítků, a nesmí obsahovat více než 256 znaků.
endpoint	path	True	string	Koncový bod, který se má použít, například https://remoterendering.eastus.mixedreality.azure.com. Seznam najdete na adrese https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Odpovědi

Name	Typ	Description
200 OK	conversion	OK. Hlavičky MS-CV: string Retry-After: integer
401 Unauthorized		Neautorizováno Chybějící nebo neplatná autorizace Hlavičky MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakázáno. Pro daný prostředek není dostatečná autorizace. Hlavičky MS-CV: string
404 Not Found		Nenalezena. Neexistuje žádný převod se zadaným ID převodu. Hlavičky MS-CV: string
429 Too Many Requests		Příliš mnoho požadavků. Byl překročen limit přenosové rychlosti. Po uplynutí doby trvání uvedené v hlavičce Retry-After zkuste požadavek zopakovat. Hlavičky MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Vnitřní chyba Na serveru došlo k vnitřní chybě. Opakování požadavku může vést k úspěšným výsledkům. Hlavičky MS-CV: string

Zabezpečení

Authorization

Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
V: header

Příklady

Get a single conversion by ID

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 401

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

Stavový kód:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 429

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

Stavový kód:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definice

Name	Description
conversion	Vlastnosti převodu.
conversion_input_settings	Nastavení vstupu převodu popisují původ vstupu převodu.
conversion_output_settings	Nastavení výstupu převodu popisuje cíl výstupu převodu.
conversion_settings	Nastavení převodu popisuje původ vstupních souborů a cíl výstupních souborů.
conversion_status	Stav převodu. Terminálové stavy jsou "Zrušeno", "Neúspěšné" a "Úspěšné".
error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.
error_response	Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.
Output	Informace o výstupu úspěšného převodu Je k dispozici pouze tehdy, když je stav převodu "Úspěch".

conversion

Vlastnosti převodu.

Name	Typ	Description
creationTime	string	Čas vytvoření převodu. Datum a čas ve formátu ISO 8601.
error	error	Objekt chyby obsahující podrobnosti o selhání převodu.
id	string	ID převodu zadaného při vytvoření převodu.
output	Output	Informace o výstupu úspěšného převodu Je k dispozici pouze tehdy, když je stav převodu "Úspěch".
settings	conversion_settings	Nastavení převodu popisuje původ vstupních souborů a cíl výstupních souborů.
status	conversion_status	Stav převodu. Terminálové stavy jsou "Zrušeno", "Neúspěšné" a "Úspěšné".

conversion_input_settings

Nastavení vstupu převodu popisují původ vstupu převodu.

Name	Typ	Description
blobPrefix	string	Pro provedení převodu se stáhnou jenom objekty blob začínající touto předponou. Nepovinný parametr. Pokud není k dispozici, stáhnou se všechny objekty blob z kontejneru.
relativeInputAssetPath	string	Relativní cesta počínaje objektem blobPrefix (nebo v kořenovém adresáři kontejneru, pokud není k dispozici blobPrefix) ke vstupnímu modelu. Musí odkazovat na soubor s podporovaným formátem. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas	string	Sdílený přístupový podpis kontejneru služby Azure Blob Storage, který poskytuje přístup pro čtení a seznam ke kontejneru úložiště. Nepovinný parametr. Pokud není účet Azure Remote Rendering zadaný, musí být propojený s účtem úložiště obsahujícím kontejner objektů blob. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Z bezpečnostních důvodů se toto pole nikdy nevyplní v orgánech odpovědí.
storageContainerUri	string	Identifikátor URI kontejneru úložiště objektů blob v Azure, který obsahuje vstupní model.

conversion_output_settings

Nastavení výstupu převodu popisuje cíl výstupu převodu.

Name	Typ	Description
blobPrefix	string	Předpona, která se předejde před všechny soubory vytvořené procesem převodu. Bude považována za virtuální složku. Nepovinný parametr. Pokud není k dispozici, budou výstupní soubory uloženy v kořenovém adresáři kontejneru.
outputAssetFilename	string	Název souboru výstupního prostředku. Musí končit na .arrAsset. Nepovinný parametr. Pokud není zadaný, bude mít název souboru stejný název jako vstupní asset s příponou .arrAsset.
storageContainerUri	string	Identifikátor URI kontejneru úložiště objektů blob v Azure, do kterého by se měl zapsat výsledek převodu.
storageContainerWriteSas	string	Sdílený přístupový podpis kontejneru služby Azure Blob Storage, který umožňuje přístup k zápisu do kontejneru úložiště. Nepovinný parametr. Pokud není účet Azure Remote Rendering zadaný, musí být propojený s účtem úložiště obsahujícím kontejner objektů blob. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Z bezpečnostních důvodů se toto pole nikdy nevyplní v orgánech odpovědí.

conversion_settings

Nastavení převodu popisuje původ vstupních souborů a cíl výstupních souborů.

Name	Typ	Description
inputLocation	conversion_input_settings	Nastavení vstupu převodu popisují původ vstupu převodu.
outputLocation	conversion_output_settings	Nastavení výstupu převodu popisuje cíl výstupu převodu.

conversion_status

Stav převodu. Terminálové stavy jsou "Zrušeno", "Neúspěšné" a "Úspěšné".

Name	Typ	Description
Cancelled	string	Převod byl zrušen. Jedná se o stav terminálu.
Failed	string	Převod se nezdařil. Další podrobnosti najdete v poli chyba. Jedná se o stav terminálu.
NotStarted	string	Převod byl vytvořen, ale nezačal.
Running	string	Převod je spuštěný.
Succeeded	string	Převod byl úspěšný. Zkontrolujte umístění výstupního prostředku v poli output . Jedná se o stav terminálu.

error

Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
code	string	Kód chyby
details	error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innerError	error	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl konkrétní chyby (např. název vlastnosti v chybě).

error_response

Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
error	error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

Output

Informace o výstupu úspěšného převodu Je k dispozici pouze tehdy, když je stav převodu "Úspěch".

Name	Typ	Description
outputAssetUri	string	URI prostředku vygenerovaného procesem převodu.

Sdílet prostřednictvím