Remote Rendering - Create Session

Riferimento

Servizio:: Mixed Reality

Versione API:: 2021-01-01

Crea una nuova sessione di rendering.

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?api-version=2021-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
account_id	path	True	string uuid	ID dell'account azure Rendering remoto.
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.
session_id	path	True	string	ID che identifica in modo univoco la sessione di rendering per l'account specificato. L'ID fa 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.
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.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
maxLeaseTimeMinutes	True	integer	L'ora in minuti della sessione verrà eseguita dopo aver raggiunto lo stato "Pronto". Deve essere compreso tra 0 e 1440.
size	True	session_size	Dimensioni del server utilizzato per la sessione di rendering. La dimensione influisce sul numero di poligoni di cui il server può eseguire il rendering. Vedere https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes per informazioni dettagliate.

Risposte

Nome	Tipo	Descrizione
200 OK	session_properties	OK. Indica che era già presente una sessione con le stesse impostazioni. Questo problema è previsto quando viene ritentata la creazione della sessione.
201 Created	session_properties	Creazione riuscita. La sessione è stata creata correttamente. Intestazioni MS-CV: string
400 Bad Request	error_response	Richiesta non valida. L'oggetto errore restituito descrive quali problemi si sono verificati. Intestazioni MS-CV: string
401 Unauthorized		Non autorizzato. Autorizzazione mancante o non valida. Intestazioni MS-CV: string WWW-Authenticate: string
403 Forbidden		Non consentito. Autorizzazione insufficiente per una risorsa specificata. Intestazioni MS-CV: string
429 Too Many Requests		Troppe richieste. È stato superato il limite di velocità. Ripetere 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. Si è verificato un errore interno del server. Il tentativo di ripetizione della richiesta può produrre risultati riusciti. Intestazioni MS-CV: string
Other Status Codes	error_response	Conflitto. Esiste già una sessione di rendering con l'ID per l'account di rendering remoto.

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

Create a rendering session

Esempio di richiesta

HTTP

PUT https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28?api-version=2021-01-01

{
  "maxLeaseTimeMinutes": 60,
  "size": "Standard"
}

Risposta di esempio

Codice di stato:: 201

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Codice di stato:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Codice di stato:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}

Codice di stato:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

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:: 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
create_session_settings	Impostazioni della sessione da creare.
error	Oggetto di 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.
session_properties	Proprietà di una sessione di rendering.
session_size	Dimensioni del server utilizzato per la sessione di rendering. La dimensione influisce sul numero di poligoni di cui il server può eseguire il rendering. Vedere https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes per informazioni dettagliate.
session_status	Stato della sessione di rendering. Gli stati del terminale sono "Error", "Expired" e "Stopped".

create_session_settings

Impostazioni della sessione da creare.

Nome	Tipo	Descrizione
maxLeaseTimeMinutes	integer	L'ora in minuti della sessione verrà eseguita dopo aver raggiunto lo stato "Pronto". Deve essere compreso tra 0 e 1440.
size	session_size	Dimensioni del server utilizzato per la sessione di rendering. La dimensione influisce sul numero di poligoni di cui il server può eseguire il rendering. Vedere https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes per informazioni dettagliate.

error

Oggetto di 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 questo 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 di errore contenente i dettagli del motivo per cui la richiesta non è riuscita.

session_properties

Proprietà di una sessione di rendering.

Nome	Tipo	Descrizione
arrInspectorPort	integer	Porta TCP in cui è ospitato lo strumento Controllo Rendering remoto di Azure.
creationTime	string	Ora di creazione della sessione di rendering. Data e ora in formato ISO 8601.
elapsedTimeMinutes	integer	Quantità di tempo in minuti in cui la sessione è o è nello stato "Pronto". Il tempo viene arrotondato per difetto a un minuto intero.
error	error	Oggetto errore contenente informazioni dettagliate sull'errore di avvio della sessione di rendering.
handshakePort	integer	Porta TCP utilizzata per l'handshake quando si stabilisce una connessione.
hostname	string	Nome host in cui è raggiungibile la sessione di rendering.
id	string	ID della sessione specificata al momento della creazione della sessione.
maxLeaseTimeMinutes	integer	L'ora in minuti della sessione verrà eseguita dopo aver raggiunto lo stato "Pronto".
size	session_size	Dimensioni del server utilizzato per la sessione di rendering. La dimensione influisce sul numero di poligoni di cui il server può eseguire il rendering. Vedere https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes per informazioni dettagliate.
status	session_status	Stato della sessione di rendering. Gli stati del terminale sono "Error", "Expired" e "Stopped".
teraflops	number	Potenza di calcolo della GPU della sessione di rendering misurata in teraflops.

session_size

Dimensioni del server utilizzato per la sessione di rendering. La dimensione influisce sul numero di poligoni di cui il server può eseguire il rendering. Vedere https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes per informazioni dettagliate.

Nome	Tipo	Descrizione
Premium	string	Dimensioni della sessione di rendering Premium.
Standard	string	Dimensioni della sessione di rendering standard.

session_status

Stato della sessione di rendering. Gli stati del terminale sono "Error", "Expired" e "Stopped".

Nome	Tipo	Descrizione
Error	string	La sessione di rendering ha rilevato un errore ed è inutilizzabile. Si tratta di uno stato terminale.
Expired	string	La sessione di rendering entra nello stato "Scaduto" quando si trova nello stato "Pronto" più a lungo del tempo di lease. Si tratta di uno stato terminale.
Ready	string	La sessione di rendering è pronta per le connessioni in ingresso.
Starting	string	La sessione di rendering viene avviata, ma non accetta ancora le connessioni in ingresso.
Stopped	string	La sessione di rendering è stata arrestata con l'operazione "Arresta sessione". Si tratta di uno stato terminale.

Condividi tramite