Remote Rendering - Create Conversion

Referenz

Dienst:: Mixed Reality

API-Version:: 2021-01-01

Erstellt eine Konvertierung mithilfe eines in einem Azure Blob Storage Konto gespeicherten Assets.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
account_id	path	True	string uuid	Die Azure Remote Rendering-Konto-ID.
conversion_id	path	True	string	Eine ID, die die Konvertierung für das angegebene Konto eindeutig identifiziert. Die ID beachtet die Groß-/Kleinschreibung, kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, und darf nicht mehr als 256 Zeichen enthalten.
endpoint	path	True	string	Der zu verwendende Endpunkt, z. B. https://remoterendering.eastus.mixedreality.azure.com. Eine Liste finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
settings	True	conversion_settings	Konvertierungseinstellungen beschreiben den Ursprung der Eingabedateien und das Ziel der Ausgabedateien.

Antworten

Name	Typ	Beschreibung
200 OK	conversion	OK. Gibt an, dass bereits eine Konvertierung mit den gleichen Einstellungen vorhanden war. Dies wird erwartet, wenn eine Konvertierungserstellung wiederholt wird. Header MS-CV: string
201 Created	conversion	Erstellt. Eine neue Konvertierung wurde erstellt. Header MS-CV: string
400 Bad Request	error_response	Ungültige Anforderung; Das zurückgegebene Fehlerobjekt beschreibt, welche Probleme aufgetreten sind. Header MS-CV: string
401 Unauthorized		Nicht autorisiert. Fehlende oder ungültige Autorisierung. Header MS-CV: string WWW-Authenticate: string
403 Forbidden		Unzulässig. Die Autorisierung reicht für eine bestimmte Ressource nicht aus. Header MS-CV: string
429 Too Many Requests		Zu viele Anforderungen. Das Ratenlimit wurde überschritten. Wiederholen Sie die Anforderung nach der im Retry-After-Header angegebenen Dauer. Header MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interner Fehler. Beim Server ist ein interner Fehler aufgetreten. Ein erneutes Wiederholen der Anforderung kann zu erfolgreichen Ergebnissen führen.
Other Status Codes	error_response	Konflikt. Eine Konvertierung ist bereits vorhanden. Ein Fehlerobjekt beschreibt, welche Probleme aufgetreten sind. Header MS-CV: string

Sicherheit

Authorization

Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
In: header

Beispiele

Create a conversion

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
conversion	Die Eigenschaften der Konvertierung.
conversion_input_settings	Konvertierungseingabeeinstellungen beschreiben den Ursprung der Konvertierungseingabe.
conversion_output_settings	Die Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.
conversion_settings	Konvertierungseinstellungen beschreiben den Ursprung der Eingabedateien und das Ziel der Ausgabedateien.
conversion_status	Der status der Konvertierung. Die Terminalzustände sind "Abgebrochen", "Fehler" und "Erfolgreich".
create_conversion_settings	Anforderung zum Starten einer Konvertierung
error	Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.
error_response	Die Fehlerantwort, die Details dazu enthält, warum die Anforderung fehlgeschlagen ist.
Output	Informationen zur Ausgabe einer erfolgreichen Konvertierung. Nur vorhanden, wenn der status der Konvertierung "Erfolgreich" lautet.

conversion

Die Eigenschaften der Konvertierung.

Name	Typ	Beschreibung
creationTime	string	Der Zeitpunkt, zu dem die Konvertierung erstellt wurde. Datum und Uhrzeit im ISO 8601-Format.
error	error	Das Fehlerobjekt, das Details zum Konvertierungsfehler enthält.
id	string	Die ID der Konvertierung, die beim Erstellen der Konvertierung angegeben wurde.
output	Output	Informationen zur Ausgabe einer erfolgreichen Konvertierung. Nur vorhanden, wenn der status der Konvertierung "Erfolgreich" lautet.
settings	conversion_settings	Konvertierungseinstellungen beschreiben den Ursprung der Eingabedateien und das Ziel der Ausgabedateien.
status	conversion_status	Der status der Konvertierung. Die Terminalzustände sind "Abgebrochen", "Fehler" und "Erfolgreich".

conversion_input_settings

Konvertierungseingabeeinstellungen beschreiben den Ursprung der Konvertierungseingabe.

Name	Typ	Beschreibung
blobPrefix	string	Nur Blobs, die mit diesem Präfix beginnen, werden heruntergeladen, um die Konvertierung durchzuführen. Optional. Falls nicht angegeben, werden alle Blobs aus dem Container heruntergeladen.
relativeInputAssetPath	string	Der relative Pfad ab blobPrefix (oder am Containerstamm, wenn blobPrefix nicht bereitgestellt wird) zum Eingabemodell. Muss auf eine Datei mit einem unterstützten Dateiformatende verweisen. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas	string	Eine Freigegebene Zugriffssignatur des Azure Blob Storage-Containers, die Lese- und Listenzugriff auf den Speichercontainer ermöglicht. Optional. Falls nicht angegeben, muss das Azure Remote Rendering-Konto mit dem Speicherkonto verknüpft werden, das den Blobcontainer enthält. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Aus Sicherheitsgründen wird dieses Feld nie in Antworttexten ausgefüllt.
storageContainerUri	string	Der URI des Azure Blob Storage-Containers, der das Eingabemodell enthält.

conversion_output_settings

Die Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.

Name	Typ	Beschreibung
blobPrefix	string	Ein Präfix, das allen dateien vorangestellt wird, die durch den Konvertierungsprozess erzeugt werden. Wird als virtueller Ordner behandelt. Optional. Falls nicht angegeben, werden die Ausgabedateien im Containerstamm gespeichert.
outputAssetFilename	string	Der Dateiname des Ausgabeobjekts. Muss auf ".arrAsset" enden. Optional. Falls nicht angegeben, hat der Dateiname denselben Namen wie das Eingabeobjekt mit der Erweiterung ".arrAsset".
storageContainerUri	string	Der URI des Azure Blob Storage-Containers, in den das Ergebnis der Konvertierung geschrieben werden soll.
storageContainerWriteSas	string	Eine Freigegebene Zugriffssignatur des Azure Blob Storage-Containers, die Schreibzugriff auf den Speichercontainer ermöglicht. Optional. Falls nicht angegeben, muss das Azure Remote Rendering-Konto mit dem Speicherkonto verknüpft werden, das den Blobcontainer enthält. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Aus Sicherheitsgründen wird dieses Feld nie in Antworttexten ausgefüllt.

conversion_settings

Konvertierungseinstellungen beschreiben den Ursprung der Eingabedateien und das Ziel der Ausgabedateien.

Name	Typ	Beschreibung
inputLocation	conversion_input_settings	Konvertierungseingabeeinstellungen beschreiben den Ursprung der Konvertierungseingabe.
outputLocation	conversion_output_settings	Die Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.

conversion_status

Der status der Konvertierung. Die Terminalzustände sind "Abgebrochen", "Fehler" und "Erfolgreich".

Name	Typ	Beschreibung
Cancelled	string	Die Konvertierung wurde abgebrochen. Dies ist ein Terminalzustand.
Failed	string	Fehler bei der Konvertierung. Weitere Informationen finden Sie im Feld "Fehler". Dies ist ein Terminalzustand.
NotStarted	string	Die Konvertierung wurde erstellt, aber nicht gestartet.
Running	string	Die Konvertierung wird ausgeführt.
Succeeded	string	Die Konvertierung wurde erfolgreich ausgeführt. Überprüfen Sie das Feld "ausgabe" auf den Speicherort des Ausgabeobjekts. Dies ist ein Terminalzustand.

create_conversion_settings

Anforderung zum Starten einer Konvertierung

Name	Typ	Beschreibung
settings	conversion_settings	Konvertierungseinstellungen beschreiben den Ursprung der Eingabedateien und das Ziel der Ausgabedateien.

error

Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
code	string	Fehlercode
details	error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	error	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des jeweiligen Fehlers (z. B. der Name der Eigenschaft im Fehler).

error_response

Die Fehlerantwort, die Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
error	error	Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

Output

Informationen zur Ausgabe einer erfolgreichen Konvertierung. Nur vorhanden, wenn der status der Konvertierung "Erfolgreich" lautet.

Name	Typ	Beschreibung
outputAssetUri	string	URI des durch den Konvertierungsprozess generierten Assets.

Freigeben über