Compartir a través de

Remote Rendering - Create Conversion

  • Referencia
Servicio:
Mixed Reality
Versión de la API:
2021-01-01

Crea una conversión mediante un recurso almacenado en una cuenta de Azure Blob Storage.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
account_id
 path True

string

uuid

Identificador de la cuenta de Azure Remote Rendering.
conversion_id
 path True

string

Identificador que identifica de forma única la conversión de la cuenta especificada. El identificador distingue mayúsculas de minúsculas, puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 256 caracteres.
endpoint
 path True

string

Punto de conexión que se va a usar, por ejemplo, https://remoterendering.eastus.mixedreality.azure.com. Puede encontrar una lista en https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud HTTP.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Authorization True

string

Token de portador devuelto por el servicio de token seguro de Mixed Reality. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
settings True

conversion_settings

La configuración de conversión describe el origen de los archivos de entrada y el destino de los archivos de salida.

Respuestas

Nombre Tipo Description
200 OK

conversion

Aceptar. Indica que ya había una conversión con la misma configuración presente. Esto se espera cuando se reintenta una creación de conversión.

Encabezados

MS-CV: string
201 Created

conversion

Creado. Se creó una nueva conversión.

Encabezados

MS-CV: string
400 Bad Request

error_response

Solicitud incorrecta. El objeto de error devuelto describe qué problemas se produjeron.

Encabezados

MS-CV: string
401 Unauthorized

No autorizado. Falta o no es válida la autorización.

Encabezados

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

Prohibido. Autorización insuficiente para un recurso determinado.

Encabezados

MS-CV: string
429 Too Many Requests

Demasiadas solicitudes Se ha superado el límite de frecuencia. Vuelva a intentar la solicitud después de la duración especificada en el encabezado Retry-After.

Encabezados

  • MS-CV: string
  • Retry-After: integer
500 Internal Server Error

error_response

Error interno. El servidor ha encontrado un error interno. Volver a intentar la solicitud puede generar resultados correctos.
Other Status Codes

error_response

Conflicto. Ya existe una conversión. Un objeto de error describe qué problemas se produjeron.

Encabezados

MS-CV: string

Seguridad

Authorization

Token de portador devuelto por el servicio de token seguro de Mixed Reality. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Tipo: apiKey
En: header

Ejemplos

Create a conversion

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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
}
status code:
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
}
status code:
400 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
status code:
409 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
status code:
401 
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
403 
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
429 
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
500 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definiciones

Nombre Description
conversion

Propiedades de la conversión.
conversion_input_settings

La configuración de entrada de conversión describe el origen de la entrada de conversión.
conversion_output_settings

La configuración de salida de conversión describe el destino de la salida de conversión.
conversion_settings

La configuración de conversión describe el origen de los archivos de entrada y el destino de los archivos de salida.
conversion_status

Estado de la conversión. Los estados de terminal son "Cancelled", "Failed" y "Succeeded".
create_conversion_settings

Solicitud para iniciar una conversión
error

Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.
error_response

Respuesta de error que contiene detalles de por qué se produjo un error en la solicitud.
Output

Información sobre la salida de una conversión correcta. Solo está presente cuando el estado de la conversión es "Correcto".

conversion

Propiedades de la conversión.

Nombre Tipo Description
creationTime

string

Hora a la que se creó la conversión. Fecha y hora en formato ISO 8601.
error

error

Objeto de error que contiene detalles sobre el error de conversión.
id

string

Identificador de la conversión proporcionada cuando se creó la conversión.
output

Output

Información sobre la salida de una conversión correcta. Solo está presente cuando el estado de la conversión es "Correcto".
settings

conversion_settings

La configuración de conversión describe el origen de los archivos de entrada y el destino de los archivos de salida.
status

conversion_status

Estado de la conversión. Los estados de terminal son "Cancelled", "Failed" y "Succeeded".

conversion_input_settings

La configuración de entrada de conversión describe el origen de la entrada de conversión.

Nombre Tipo Description
blobPrefix

string

Solo los blobs que comienzan con este prefijo se descargarán para realizar la conversión. Opcional. Si no se proporciona, se descargarán todos los blobs del contenedor.
relativeInputAssetPath

string

Ruta de acceso relativa que comienza en blobPrefix (o en la raíz del contenedor si no se proporciona blobPrefix) al modelo de entrada. Debe apuntar a un archivo con un formato de archivo compatible que termine. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas

string

Una firma de acceso compartido de contenedor de Azure Blob Storage que proporciona acceso de lectura y lista al contenedor de almacenamiento. Opcional. Si no se proporciona, la cuenta de Azure Remote Rendering debe vincularse con la cuenta de almacenamiento que contiene el contenedor de blobs. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Para fines de seguridad, este campo nunca se rellenará en los cuerpos de respuestas.
storageContainerUri

string

El URI del contenedor de Azure Blob Storage que contiene el modelo de entrada.

conversion_output_settings

La configuración de salida de conversión describe el destino de la salida de conversión.

Nombre Tipo Description
blobPrefix

string

Prefijo que se antepone delante de todos los archivos generados por el proceso de conversión. Se tratará como una carpeta virtual. Opcional. Si no se proporciona, los archivos de salida se almacenarán en la raíz del contenedor.
outputAssetFilename

string

Nombre de archivo del recurso de salida. Debe terminar en '.arrAsset'. Opcional. Si no se proporciona, el nombre de archivo será el mismo que el recurso de entrada, con la extensión ".arrAsset".
storageContainerUri

string

URI del contenedor de Azure Blob Storage en el que se debe escribir el resultado de la conversión.
storageContainerWriteSas

string

Una firma de acceso compartido de contenedor de Azure Blob Storage que proporciona acceso de escritura al contenedor de almacenamiento. Opcional. Si no se proporciona, la cuenta de Azure Remote Rendering debe vincularse con la cuenta de almacenamiento que contiene el contenedor de blobs. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Para fines de seguridad, este campo nunca se rellenará en los cuerpos de respuestas.

conversion_settings

La configuración de conversión describe el origen de los archivos de entrada y el destino de los archivos de salida.

Nombre Tipo Description
inputLocation

conversion_input_settings

La configuración de entrada de conversión describe el origen de la entrada de conversión.
outputLocation

conversion_output_settings

La configuración de salida de conversión describe el destino de la salida de conversión.

conversion_status

Estado de la conversión. Los estados de terminal son "Cancelled", "Failed" y "Succeeded".

Nombre Tipo Description
Cancelled

string

Se canceló la conversión. Se trata de un estado terminal.
Failed

string

Error en la conversión. Compruebe el campo "error" para obtener más detalles. Se trata de un estado terminal.
NotStarted

string

La conversión se creó, pero no se ha iniciado.
Running

string

La conversión se está ejecutando.
Succeeded

string

La conversión se ha realizado correctamente. Compruebe el campo "output" para ver la ubicación del recurso de salida. Se trata de un estado terminal.

create_conversion_settings

Solicitud para iniciar una conversión

Nombre Tipo Description
settings

conversion_settings

La configuración de conversión describe el origen de los archivos de entrada y el destino de los archivos de salida.

error

Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.

Nombre Tipo Description
code

string

Código de error.
details

error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError

error

Objeto que contiene información más específica que el objeto actual sobre el error.
message

string

Representación legible del error.
target

string

Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

error_response

Respuesta de error que contiene detalles de por qué se produjo un error en la solicitud.

Nombre Tipo Description
error

error

Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.

Output

Información sobre la salida de una conversión correcta. Solo está presente cuando el estado de la conversión es "Correcto".

Nombre Tipo Description
outputAssetUri

string

URI del recurso generado por el proceso de conversión.