Sdílet prostřednictvím

Remote Rendering - Create Conversion

  • Reference
Služba:
Mixed Reality
Verze rozhraní API:
2021-01-01

Vytvoří převod pomocí prostředku uloženého v účtu Azure Blob Storage.

PUT {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.

Text požadavku

Name Vyžadováno Typ Description
settings True

conversion_settings

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

Odpovědi

Name Typ Description
200 OK

conversion

OK. Označuje, že již došlo k převodu se stejným nastavením. To se očekává při opakovaném vytvoření převodu.

Hlavičky

MS-CV: string
201 Created

conversion

Vytvořen. Byl vytvořen nový převod.

Hlavičky

MS-CV: string
400 Bad Request

error_response

Chybný požadavek. Vrácený objekt chyby popisuje, ke kterým problémům došlo.

Hlavičky

MS-CV: string
401 Unauthorized

Neautorizováno Chybí nebo je autorizace neplatná.

Hlavičky

  • MS-CV: string
  • WWW-Authenticate: string
403 Forbidden

Zakázáno. Autorizace pro daný prostředek není dostatečná.

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 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.
Other Status Codes

error_response

Konflikt. Převod již existuje. Objekt chyby popisuje, ke kterým problémům došlo.

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

Create a conversion

Ukázkový požadavek

PUT 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

{
  "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"
    }
  }
}

Ukázková odpověď

Stavový kód:
201 
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": "NotStarted",
  "error": null
}
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": "NotStarted",
  "error": null
}
Stavový kód:
400 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
Stavový kód:
409 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
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:
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 popisují původ vstupních souborů a cíl výstupních souborů.
conversion_status

Stav převodu. Terminálové stavy jsou "Zrušeno", "Selhání" a "Úspěch".
create_conversion_settings

Žádost o zahájení převodu
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. K dispozici, pouze pokud 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 chybě 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. K dispozici, pouze pokud je stav převodu "Úspěch".
settings

conversion_settings

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

conversion_status

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

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í na tuto předponu. Nepovinný parametr. Pokud není zadaný, 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í zadaný 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 úložiště objektů blob Azure, který poskytuje přístup ke kontejneru úložiště pro čtení a seznam. 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ů nebude toto pole nikdy vyplněno 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řidá před všechny soubory vytvořené procesem převodu. Bude se považovat za virtuální složku. Nepovinný parametr. Pokud je nezadáte, výstupní soubory se uloží 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ý, název souboru bude stejný jako vstupní asset s příponou .arrAsset.
storageContainerUri

string

Identifikátor URI kontejneru úložiště objektů blob v Azure, do kterého se má zapsat výsledek převodu.
storageContainerWriteSas

string

Sdílený přístupový podpis kontejneru služby Azure Blob Storage, který uděluje přístup pro zápis 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ů nebude toto pole nikdy vyplněno v orgánech odpovědí.

conversion_settings

Nastavení převodu popisují 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", "Selhání" a "Úspěch".

Name Typ Description
Cancelled

string

Převod byl zrušen. Toto je terminální stav.
Failed

string

Převod se nezdařil. Další podrobnosti najdete v poli chyba. Toto je terminální stav.
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". Toto je terminální stav.

create_conversion_settings

Žádost o zahájení převodu

Name Typ Description
settings

conversion_settings

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

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. K dispozici, pouze pokud je stav převodu "Úspěch".

Name Typ Description
outputAssetUri

string

Identifikátor URI prostředku vygenerovaného procesem převodu.