Remote Rendering - Create Conversion

Referentie

Service:: Mixed Reality

API-versie:: 2021-01-01

Hiermee maakt u een conversie met behulp van een asset die is opgeslagen in een Azure Blob Storage-account.

PUT {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 de Azure Remote Rendering.
conversion_id	path	True	string	Een id die de conversie voor het opgegeven account uniek identificeert. De id is hoofdlettergevoelig, kan een willekeurige 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 vindt u 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.

Aanvraagbody

Name	Vereist	Type	Description
settings	True	conversion_settings	Conversie-instellingen beschrijven de oorsprong van invoerbestanden en de bestemming van uitvoerbestanden.

Antwoorden

Name	Type	Description
200 OK	conversion	OK. Geeft aan dat er al een conversie is uitgevoerd met dezelfde instellingen die aanwezig zijn. Dit is te verwachten wanneer een conversie opnieuw wordt gemaakt. Kopteksten MS-CV: string
201 Created	conversion	Gemaakt. Er is een nieuwe conversie gemaakt. Kopteksten MS-CV: string
400 Bad Request	error_response	Ongeldige aanvraag. Geretourneerd foutobject beschrijft welke problemen zijn opgetreden. Kopteksten MS-CV: string
401 Unauthorized		Onbevoegd. Ontbrekende of ongeldige autorisatie. Kopteksten MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboden. Autorisatie is onvoldoende voor de opgegeven resource. 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 op de server. Het opnieuw proberen van de aanvraag kan resultaten opleveren.
Other Status Codes	error_response	Conflict. Er bestaat al een conversie. Een foutobject beschrijft welke problemen zijn opgetreden. 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

Create a conversion

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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
}

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": "NotStarted",
  "error": null
}

Statuscode:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}

Statuscode:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

Statuscode:: 401

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

Statuscode:: 403

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	Met de instellingen voor conversie-invoer wordt de oorsprong van de conversie-invoer beschreven.
conversion_output_settings	Instellingen voor conversie-uitvoer beschrijven het doel van de conversie-uitvoer.
conversion_settings	Conversie-instellingen beschrijven de oorsprong van invoerbestanden en de bestemming van uitvoerbestanden.
conversion_status	De status van de conversie. Terminalstatussen zijn 'Geannuleerd', 'Mislukt' en 'Geslaagd'.
create_conversion_settings	Aanvraag om een conversie te starten
error	Het foutobject met details over waarom de aanvraag is mislukt.
error_response	Het foutbericht met details over 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

De eigenschappen van de conversie.

Name	Type	Description
creationTime	string	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 de bestemming van uitvoerbestanden.
status	conversion_status	De status van de conversie. Terminalstatussen zijn 'Geannuleerd', 'Mislukt' en 'Geslaagd'.

conversion_input_settings

Met de instellingen voor conversie-invoer wordt de oorsprong van de conversie-invoer beschreven.

Name	Type	Description
blobPrefix	string	Alleen blobs die beginnen met dit voorvoegsel worden gedownload om de conversie uit te voeren. Optioneel. Als deze niet is 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) naar 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 Shared Access Signature voor een Azure Blob Storage-container die lees- en lijsttoegang geeft tot de opslagcontainer. Optioneel. 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. Om veiligheidsredenen wordt dit veld nooit ingevuld in antwoordteksten.
storageContainerUri	string	De URI van de Azure Blob Storage-container die het invoermodel bevat.

conversion_output_settings

Instellingen voor conversie-uitvoer 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. Optioneel. Als deze niet wordt opgegeven, worden uitvoerbestanden opgeslagen in de hoofdmap van de container.
outputAssetFilename	string	De bestandsnaam van de uitvoerasset. Moet eindigen op '.arrAsset'. Optioneel. Als deze niet wordt opgegeven, krijgt de bestandsnaam dezelfde naam als de invoerasset, met de extensie .arrAsset
storageContainerUri	string	De URI van de Azure Blob Storage-container waarnaar het resultaat van de conversie moet worden geschreven.
storageContainerWriteSas	string	Een Shared Access Signature voor Azure Blob Storage-containers die schrijftoegang tot de opslagcontainer biedt. Optioneel. 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. Om veiligheidsredenen wordt dit veld nooit ingevuld in antwoordteksten.

conversion_settings

Conversie-instellingen beschrijven de oorsprong van invoerbestanden en de bestemming van uitvoerbestanden.

Name	Type	Description
inputLocation	conversion_input_settings	Met de instellingen voor conversie-invoer wordt de oorsprong van de conversie-invoer beschreven.
outputLocation	conversion_output_settings	Instellingen voor conversie-uitvoer beschrijven het doel van de conversie-uitvoer.

conversion_status

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

Name	Type	Description
Cancelled	string	De conversie is geannuleerd. Dit is een terminale status.
Failed	string	De conversie is mislukt. Controleer het veld 'fout' voor meer informatie. Dit is een terminale status.
NotStarted	string	De conversie is gemaakt, maar is nog niet gestart.
Running	string	De conversie wordt uitgevoerd.
Succeeded	string	De conversie is voltooid. Controleer in het veld 'uitvoer' de locatie van de uitvoerasset. Dit is een terminale status.

create_conversion_settings

Aanvraag om een conversie te starten

Name	Type	Description
settings	conversion_settings	Conversie-instellingen beschrijven de oorsprong van invoerbestanden en de bestemming van uitvoerbestanden.

error

Het foutobject met details over waarom de aanvraag is mislukt.

Name	Type	Description
code	string	Foutcode.
details	error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innerError	error	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap met fout).

error_response

Het foutbericht met details over waarom de aanvraag is mislukt.

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

Output

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

Name	Type	Description
outputAssetUri	string	URI van de asset die is gegenereerd door het conversieproces.

Delen via