Freigeben über

Remote Rendering - Create Conversion

  • Referenz
Dienst:
Mixed Reality
API-Version:
2021-01-01

Erstellt eine Konvertierung mithilfe einer Ressource, die in einem Azure Blob Storage-Konto gespeichert ist.

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. Bei der ID wird die Groß-/Kleinschreibung beachtet, kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten 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. Weitere Informationen 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 von Ausgabedateien.

Antworten

Name Typ Beschreibung
200 OK

conversion

OKAY. Gibt an, dass bereits eine Konvertierung mit denselben Einstellungen vorhanden war. Dies wird erwartet, wenn eine Konvertierungserstellung erneut ausgeführt wird.

Header

MS-CV: string
201 Created

conversion

Erstellt. Es wurde eine neue Konvertierung 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

Unbefugt. Fehlende oder ungültige Autorisierung.

Header

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

Verboten. Die Autorisierung ist für bestimmte Ressourcen nicht ausreichend.

Header

MS-CV: string
429 Too Many Requests

Zu viele Anforderungen. Das Zinslimit 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. Auf dem Server ist ein interner Fehler aufgetreten. Das 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. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
In: header

Beispiele

Create a conversion

Beispielanforderung

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

Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.
conversion_settings

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

Der Status der Konvertierung. Terminalzustände sind "Abgebrochen", "Fehlgeschlagen" und "Erfolgreich".
create_conversion_settings

Anforderung zum Starten einer Konvertierung
error

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

Die Fehlerantwort mit Details dazu, warum die Anforderung fehlgeschlagen ist.
Output

Informationen zur Ausgabe einer erfolgreichen Konvertierung. Nur vorhanden, wenn der Status der Konvertierung "Erfolgreich" ist.

conversion

Objekt

Die Eigenschaften der Konvertierung.

Name Typ Beschreibung
creationTime

string (date-time)

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" ist.
settings

conversion_settings

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

conversion_status

Der Status der Konvertierung. Terminalzustände sind "Abgebrochen", "Fehlgeschlagen" und "Erfolgreich".

conversion_input_settings

Objekt

Konvertierungseingabeeinstellungen beschreiben den Ursprung der Konvertierungseingabe.

Name Typ Beschreibung
blobPrefix

string

Nur Blobs, die mit diesem Präfix beginnen, werden heruntergeladen, um die Konvertierung auszuführen. Wahlfrei. Wenn nicht angegeben, werden alle Blobs aus dem Container heruntergeladen.
relativeInputAssetPath

string

Der relative Pfad ab blobPrefix (oder im Containerstamm, wenn blobPrefix nicht bereitgestellt wird) für das Eingabemodell. Muss auf eine Datei zeigen, bei der ein unterstütztes Dateiformat endet. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas

string

Ein Freigegebener Azure Blob Storage-Container, der Lese- und Listenzugriff auf den Speichercontainer ermöglicht. Wahlfrei. Wenn nicht angegeben, muss das Azure Remote Rendering-Konto mit dem Speicherkonto verknüpft werden, das den BLOB-Container enthält. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Für Sicherheitszwecke wird dieses Feld niemals in Antworttexten ausgefüllt.
storageContainerUri

string (uri)

Der URI des Azure Blob Storage-Containers, der das Eingabemodell enthält.

conversion_output_settings

Objekt

Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.

Name Typ Beschreibung
blobPrefix

string

Ein Präfix, das vor allen Dateien vorgestellt wird, die vom Konvertierungsprozess erstellt werden. Wird als virtueller Ordner behandelt. Wahlfrei. Falls nicht angegeben, werden Ausgabedateien im Containerstamm gespeichert.
outputAssetFilename

string

Der Dateiname des Ausgabeobjekts. Muss in '.arrAsset' enden. Wahlfrei. Wenn nicht angegeben, wird der Dateiname mit der Erweiterung ".arrAsset" mit demselben Namen wie die Eingaberessource verwendet.
storageContainerUri

string (uri)

Der URI des Azure Blob Storage-Containers, in den das Ergebnis der Konvertierung geschrieben werden soll.
storageContainerWriteSas

string

Ein Freigegebener Azure Blob Storage-Container, der Schreibzugriff auf den Speichercontainer ermöglicht. Wahlfrei. Wenn nicht angegeben, muss das Azure Remote Rendering-Konto mit dem Speicherkonto verknüpft werden, das den BLOB-Container enthält. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Für Sicherheitszwecke wird dieses Feld niemals in Antworttexten ausgefüllt.

conversion_settings

Objekt

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

Name Typ Beschreibung
inputLocation

conversion_input_settings

Konvertierungseingabeeinstellungen beschreiben den Ursprung der Konvertierungseingabe.
outputLocation

conversion_output_settings

Konvertierungsausgabeeinstellungen beschreiben das Ziel der Konvertierungsausgabe.

conversion_status

Enumeration

Der Status der Konvertierung. Terminalzustände sind "Abgebrochen", "Fehlgeschlagen" und "Erfolgreich".

Wert Beschreibung
Cancelled

Die Konvertierung wurde abgebrochen. Dies ist ein Terminalzustand.
Failed

Fehler bei der Konvertierung. Weitere Details finden Sie im Feld "Fehler". Dies ist ein Terminalzustand.
NotStarted

Die Konvertierung wurde erstellt, aber nicht gestartet.
Running

Die Konvertierung wird ausgeführt.
Succeeded

Die Konvertierung ist erfolgreich. Überprüfen Sie das Feld "ausgabe" auf den Speicherort der Ausgaberessource. Dies ist ein Terminalzustand.

create_conversion_settings

Objekt

Anforderung zum Starten einer Konvertierung

Name Typ Beschreibung
settings

conversion_settings

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

error

Objekt

Das Fehlerobjekt, das Details 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 lesbare Darstellung des Fehlers.
target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

error_response

Objekt

Die Fehlerantwort mit Details dazu, warum die Anforderung fehlgeschlagen ist.

Name Typ Beschreibung
error

error

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

Output

Objekt

Informationen zur Ausgabe einer erfolgreichen Konvertierung. Nur vorhanden, wenn der Status der Konvertierung "Erfolgreich" ist.

Name Typ Beschreibung
outputAssetUri

string (uri)

URI der Ressource, die vom Konvertierungsprozess generiert wird.