Remote Rendering - Get Conversion

Servizio:

Mixed Reality

Versione API:

2021-01-01

Ottiene lo stato di una determinata conversione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
account_id	path	True	string uuid	ID account di Azure Rendering remoto.
conversion_id	path	True	string	ID che identifica in modo univoco la conversione per l'account specificato. L'ID è distinzione tra maiuscole e minuscole, può contenere qualsiasi combinazione di caratteri alfanumerici, inclusi trattini e caratteri di sottolineatura, e non può contenere più di 256 caratteri.
endpoint	path	True	string	Endpoint da usare, https://remoterendering.eastus.mixedreality.azure.comad esempio . Un elenco è disponibile in https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	Versione dell'API da usare con la richiesta HTTP.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Token di connessione restituito dal Realtà mista Servizio token sicuro. Per informazioni dettagliate, vedere https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Risposte

Nome	Tipo	Descrizione
200 OK	conversion	OK. Intestazioni MS-CV: string Retry-After: integer
401 Unauthorized		Non autorizzato. Autorizzazione mancante o non valida. Intestazioni MS-CV: string WWW-Authenticate: string
403 Forbidden		Non consentito. Autorizzazione insufficiente per la risorsa specificata. Intestazioni MS-CV: string
404 Not Found		Non trovato. Non esiste alcuna conversione con l'ID di conversione specificato. Intestazioni MS-CV: string
429 Too Many Requests		Troppe richieste. Il limite di velocità è stato superato. Riprovare la richiesta dopo la durata specificata nell'intestazione Retry-After. Intestazioni MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Errore interno. Il server ha rilevato un errore interno. Il tentativo di ripetizione della richiesta può produrre risultati riusciti. Intestazioni MS-CV: string

Sicurezza

Authorization

Token di connessione restituito dal Realtà mista Servizio token sicuro. Per informazioni dettagliate, vedere https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Tipo: apiKey
In: header

Esempio

Get a single conversion by ID

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

401

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

Codice di stato:

403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Codice di stato:

404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Codice di stato:

429

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

Codice di stato:

500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definizioni

Nome	Descrizione
conversion	Proprietà della conversione.
conversion_input_settings	Le impostazioni di input di conversione descrivono l'origine dell'input di conversione.
conversion_output_settings	Le impostazioni di output della conversione descrivono la destinazione dell'output della conversione.
conversion_settings	Le impostazioni di conversione descrivono l'origine dei file di input e la destinazione dei file di output.
conversion_status	Stato della conversione. Gli stati del terminale sono "Annullati", "Non riuscito" e "Riuscito".
error	Oggetto errore contenente i dettagli del motivo per cui la richiesta non è riuscita.
error_response	Risposta di errore contenente i dettagli del motivo per cui la richiesta non è riuscita.
Output	Informazioni sull'output di una conversione riuscita. Presente solo quando lo stato della conversione è "Successed".

conversion

Proprietà della conversione.

Nome	Tipo	Descrizione
creationTime	string	Ora in cui è stata creata la conversione. Data e ora in formato ISO 8601.
error	error	Oggetto errore contenente dettagli sull'errore di conversione.
id	string	ID della conversione specificata al momento della creazione della conversione.
output	Output	Informazioni sull'output di una conversione riuscita. Presente solo quando lo stato della conversione è "Successed".
settings	conversion_settings	Le impostazioni di conversione descrivono l'origine dei file di input e la destinazione dei file di output.
status	conversion_status	Stato della conversione. Gli stati del terminale sono "Annullati", "Non riuscito" e "Riuscito".

conversion_input_settings

Le impostazioni di input di conversione descrivono l'origine dell'input di conversione.

Nome	Tipo	Descrizione
blobPrefix	string	Solo i BLOB che iniziano con questo prefisso verranno scaricati per eseguire la conversione. facoltativo. Se non specificato, tutti i BLOB dal contenitore verranno scaricati.
relativeInputAssetPath	string	Percorso relativo a partire da BLOBPrefix (o nella radice del contenitore se BLOBPrefix non viene fornito) al modello di input. Deve puntare a un file con una fine del formato di file supportata. Per informazioni dettagliate, vedere https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas	string	Firma di accesso condiviso del contenitore di archiviazione BLOB di Azure che fornisce l'accesso in lettura e elenco al contenitore di archiviazione. facoltativo. In caso contrario, l'account di Rendering remoto di Azure deve essere collegato all'account di archiviazione contenente il contenitore BLOB. Per informazioni dettagliate, vedere https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. A scopo di sicurezza questo campo non verrà mai compilato nei corpi delle risposte.
storageContainerUri	string	URI del contenitore di archiviazione BLOB di Azure contenente il modello di input.

conversion_output_settings

Le impostazioni di output della conversione descrivono la destinazione dell'output della conversione.

Nome	Tipo	Descrizione
blobPrefix	string	Prefisso che viene preceduto da tutti i file generati dal processo di conversione. Verrà considerato come una cartella virtuale. facoltativo. Se non specificato, i file di output verranno archiviati nella radice del contenitore.
outputAssetFilename	string	Nome file dell'asset di output. Deve terminare in '.arrAsset'. facoltativo. Se non specificato, il nome del file corrisponderà allo stesso nome dell'asset di input, con estensione '.arrAsset'
storageContainerUri	string	URI del contenitore di archiviazione BLOB di Azure in cui deve essere scritto il risultato della conversione.
storageContainerWriteSas	string	Firma di accesso condiviso del contenitore di archiviazione BLOB di Azure che consente l'accesso in scrittura al contenitore di archiviazione. facoltativo. In caso contrario, l'account di Rendering remoto di Azure deve essere collegato all'account di archiviazione contenente il contenitore BLOB. Per informazioni dettagliate, vedere https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. A scopo di sicurezza questo campo non verrà mai compilato nei corpi delle risposte.

conversion_settings

Le impostazioni di conversione descrivono l'origine dei file di input e la destinazione dei file di output.

Nome	Tipo	Descrizione
inputLocation	conversion_input_settings	Le impostazioni di input di conversione descrivono l'origine dell'input di conversione.
outputLocation	conversion_output_settings	Le impostazioni di output della conversione descrivono la destinazione dell'output della conversione.

conversion_status

Stato della conversione. Gli stati del terminale sono "Annullati", "Non riuscito" e "Riuscito".

Nome	Tipo	Descrizione
Cancelled	string	La conversione è stata annullata. Si tratta di uno stato terminale.
Failed	string	La conversione non è riuscita. Controllare il campo 'error' per altri dettagli. Si tratta di uno stato terminale.
NotStarted	string	La conversione è stata creata ma non è stata avviata.
Running	string	La conversione è in esecuzione.
Succeeded	string	La conversione ha avuto esito positivo. Controllare il campo 'output' per la posizione dell'asset di output. Si tratta di uno stato terminale.

error

Oggetto errore contenente i dettagli del motivo per cui la richiesta non è riuscita.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innerError	error	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

error_response

Risposta di errore contenente i dettagli del motivo per cui la richiesta non è riuscita.

Nome	Tipo	Descrizione
error	error	Oggetto errore contenente i dettagli del motivo per cui la richiesta non è riuscita.

Output

Informazioni sull'output di una conversione riuscita. Presente solo quando lo stato della conversione è "Successed".

Nome	Tipo	Descrizione
outputAssetUri	string	URI dell'asset generato dal processo di conversione.