Remote Rendering - Get Conversion

Referência

Serviço:: Mixed Reality

Versão da API:: 2021-01-01

Obtém o status de uma conversão específica.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
account_id	path	True	string (uuid)	A ID da conta de Renderização Remota do Azure.
conversion_id	path	True	string	Uma ID que identifica exclusivamente a conversão para a conta fornecida. A ID diferencia maiúsculas de minúsculas, pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 256 caracteres.
endpoint	path	True	string	O ponto de extremidade a ser usado, por exemplo, https://remoterendering.eastus.mixedreality.azure.com. Uma lista pode ser encontrada em https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de portador retornado pelo Serviço de Token Seguro de Realidade Misturada. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Respostas

Nome	Tipo	Description
200 OK	conversion	OKEY. Cabeçalhos MS-CV: string Retry-After: integer
401 Unauthorized		Desautorizado. Autorização ausente ou inválida. Cabeçalhos MS-CV: string WWW-Authenticate: string
403 Forbidden		Proibido. Autorização insuficiente para determinado recurso. Cabeçalhos MS-CV: string
404 Not Found		Não encontrado. Não existe nenhuma conversão com a ID de conversão fornecida. Cabeçalhos MS-CV: string
429 Too Many Requests		Muitas solicitações. O limite de taxa foi excedido. Tente novamente a solicitação após a duração fornecida no cabeçalho Retry-After. Cabeçalhos MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Erro interno. O servidor encontrou um erro interno. Tentar novamente a solicitação pode produzir resultados bem-sucedidos. Cabeçalhos MS-CV: string

Segurança

Authorization

Um token de portador retornado pelo Serviço de Token Seguro de Realidade Misturada. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Tipo: apiKey
Em: header

Exemplos

Get a single conversion by ID

Solicitação de exemplo

HTTP

GET 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

Resposta de exemplo

Código de status:: 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": "Succeeded",
  "error": null,
  "output": {
    "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset"
  }
}

Código de status:: 401

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

Código de status:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 429

Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definições

Nome	Description
conversion	As propriedades da conversão.
conversion_input_settings	As configurações de entrada de conversão descrevem a origem da entrada de conversão.
conversion_output_settings	As configurações de saída de conversão descrevem o destino da saída de conversão.
conversion_settings	As configurações de conversão descrevem a origem dos arquivos de entrada e o destino dos arquivos de saída.
conversion_status	O status da conversão. Os estados do terminal são 'Cancelado', 'Falha' e 'Bem-sucedido'.
error	O objeto de erro que contém detalhes de por que a solicitação falhou.
error_response	A resposta de erro que contém detalhes de por que a solicitação falhou.
Output	Informações sobre a saída de uma conversão bem-sucedida. Presente somente quando o status da conversão for 'Êxito'.

conversion

Objeto

As propriedades da conversão.

Nome	Tipo	Description
creationTime	string (date-time)	A hora em que a conversão foi criada. Data e hora no formato ISO 8601.
error	error	O objeto de erro que contém detalhes sobre a falha de conversão.
id	string	A ID da conversão fornecida quando a conversão foi criada.
output	Output	Informações sobre a saída de uma conversão bem-sucedida. Presente somente quando o status da conversão for 'Êxito'.
settings	conversion_settings	As configurações de conversão descrevem a origem dos arquivos de entrada e o destino dos arquivos de saída.
status	conversion_status	O status da conversão. Os estados do terminal são 'Cancelado', 'Falha' e 'Bem-sucedido'.

conversion_input_settings

Objeto

As configurações de entrada de conversão descrevem a origem da entrada de conversão.

Nome	Tipo	Description
blobPrefix	string	Somente blobs começando com esse prefixo serão baixados para executar a conversão. Opcional. Se não for fornecido, todos os Blobs do contêiner serão baixados.
relativeInputAssetPath	string	O caminho relativo começando no blobPrefix (ou na raiz do contêiner se blobPrefix não for fornecido) para o modelo de entrada. Deve apontar para um arquivo com um formato de arquivo com suporte final. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion para obter detalhes.
storageContainerReadListSas	string	Uma assinatura de acesso compartilhado do contêiner de armazenamento de blobs do Azure que dá acesso de leitura e lista ao contêiner de armazenamento. Opcional. Se não for fornecido, a conta de Renderização Remota do Azure precisará ser vinculada à conta de armazenamento que contém o contêiner de blob. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts para obter detalhes. Para fins de segurança, esse campo nunca será preenchido em corpos de respostas.
storageContainerUri	string (uri)	O URI do contêiner de armazenamento de blobs do Azure que contém o modelo de entrada.

conversion_output_settings

Objeto

As configurações de saída de conversão descrevem o destino da saída de conversão.

Nome	Tipo	Description
blobPrefix	string	Um prefixo que é acrescentado na frente de todos os arquivos produzidos pelo processo de conversão. Será tratada como uma pasta virtual. Opcional. Se não for fornecido, os arquivos de saída serão armazenados na raiz do contêiner.
outputAssetFilename	string	O nome do arquivo do ativo de saída. Deve terminar em '.arrAsset'. Opcional. Se não for fornecido, o nome do arquivo terá o mesmo nome do ativo de entrada, com a extensão '.arrAsset'
storageContainerUri	string (uri)	O URI do contêiner de armazenamento de blobs do Azure no qual o resultado da conversão deve ser gravado.
storageContainerWriteSas	string	Uma assinatura de acesso compartilhado do contêiner de armazenamento de blobs do Azure que dá acesso de gravação ao contêiner de armazenamento. Opcional. Se não for fornecido, a conta de Renderização Remota do Azure precisará ser vinculada à conta de armazenamento que contém o contêiner de blob. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts para obter detalhes. Para fins de segurança, esse campo nunca será preenchido em corpos de respostas.

conversion_settings

Objeto

As configurações de conversão descrevem a origem dos arquivos de entrada e o destino dos arquivos de saída.

Nome	Tipo	Description
inputLocation	conversion_input_settings	As configurações de entrada de conversão descrevem a origem da entrada de conversão.
outputLocation	conversion_output_settings	As configurações de saída de conversão descrevem o destino da saída de conversão.

conversion_status

Enumeração

O status da conversão. Os estados do terminal são 'Cancelado', 'Falha' e 'Bem-sucedido'.

Valor	Description
Cancelled	A conversão foi cancelada. Esse é um estado terminal.
Failed	A conversão falhou. Verifique o campo "erro" para obter mais detalhes. Esse é um estado terminal.
NotStarted	A conversão foi criada, mas não foi iniciada.
Running	A conversão está em execução.
Succeeded	A conversão foi bem-sucedida. Verifique o campo "saída" para o local do ativo de saída. Esse é um estado terminal.

error

Objeto

O objeto de erro que contém detalhes de por que a solicitação falhou.

Nome	Tipo	Description
code	string	Código de erro.
details	error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innerError	error	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

error_response

Objeto

A resposta de erro que contém detalhes de por que a solicitação falhou.

Nome	Tipo	Description
error	error	O objeto de erro que contém detalhes de por que a solicitação falhou.

Output

Objeto

Informações sobre a saída de uma conversão bem-sucedida. Presente somente quando o status da conversão for 'Êxito'.

Nome	Tipo	Description
outputAssetUri	string (uri)	URI do ativo gerado pelo processo de conversão.

Compartilhar via

Remote Rendering - Get Conversion

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

Authorization

Exemplos

Get a single conversion by ID

Solicitação de exemplo

Resposta de exemplo

Definições

conversion

conversion_input_settings

conversion_output_settings

conversion_settings

conversion_status

error

error_response

Output

Recursos adicionais