Remote Rendering - Create Session

Reference

Služba:: Mixed Reality

Verze rozhraní API:: 2021-01-01

Vytvoří novou relaci vykreslování.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
account_id	path	True	string uuid	ID účtu Azure Remote Rendering.
endpoint	path	True	string	Koncový bod, který se má použít, například https://remoterendering.eastus.mixedreality.azure.com. Seznam najdete na adrese https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	ID jednoznačně identifikující relaci vykreslování pro daný účet. V ID se rozlišují velká a malá písmena, může obsahovat libovolnou kombinaci alfanumerických znaků, včetně spojovníků a podtržítků, a nesmí obsahovat více než 256 znaků.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Text požadavku

Name	Vyžadováno	Typ	Description
maxLeaseTimeMinutes	True	integer	Čas v minutách, kdy se relace spustí po dosažení stavu Připraveno. Musí být mezi 0 a 1440.
size	True	session_size	Velikost serveru použitého pro relaci vykreslování. Velikost ovlivňuje počet mnohoúhelníku, které může server vykreslit. Podrobnosti najdete v tématu https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

Odpovědi

Name	Typ	Description
200 OK	session_properties	OK. Označuje, že už proběhla relace se stejným nastavením. To se očekává při opakovaném vytvoření relace.
201 Created	session_properties	Vytvořen. Relace se úspěšně vytvořila. Hlavičky MS-CV: string
400 Bad Request	error_response	Chybný požadavek. Vrácený objekt chyby popisuje, ke kterým problémům došlo. Hlavičky MS-CV: string
401 Unauthorized		Neautorizováno Chybějící nebo neplatná autorizace Hlavičky MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakázáno. Pro daný prostředek není dostatečná autorizace. Hlavičky MS-CV: string
429 Too Many Requests		Příliš mnoho požadavků. Byl překročen limit přenosové rychlosti. Po uplynutí doby trvání uvedené v hlavičce Retry-After zkuste požadavek zopakovat. Hlavičky MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Vnitřní chyba Na serveru došlo k vnitřní chybě. Opakování požadavku může vést k úspěšným výsledkům. Hlavičky MS-CV: string
Other Status Codes	error_response	Konflikt. Relace vykreslování s ID pro účet vzdáleného vykreslování již existuje.

Zabezpečení

Authorization

Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
V: header

Příklady

Create a rendering session

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
}

Stavový kód:: 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
}

Stavový kód:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Stavový kód:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Stavový kód:: 401

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

Stavový kód:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 429

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

Stavový kód:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definice

Name	Description
create_session_settings	Nastavení relace, která se má vytvořit.
error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.
error_response	Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.
session_properties	Vlastnosti relace vykreslování.
session_size	Velikost serveru použitého pro relaci vykreslování. Velikost ovlivňuje počet mnohoúhelníku, které může server vykreslit. Podrobnosti najdete v tématu https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .
session_status	Stav relace vykreslování. Terminálové stavy jsou Error (Chyba), Expired (Platnost vypršela) a Stopped (Zastaveno).

create_session_settings

Nastavení relace, která se má vytvořit.

Name	Typ	Description
maxLeaseTimeMinutes	integer	Čas v minutách, kdy se relace spustí po dosažení stavu Připraveno. Musí být mezi 0 a 1440.
size	session_size	Velikost serveru použitého pro relaci vykreslování. Velikost ovlivňuje počet mnohoúhelníku, které může server vykreslit. Podrobnosti najdete v tématu https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

error

Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
code	string	Kód chyby
details	error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innerError	error	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl konkrétní chyby (např. název vlastnosti v chybě).

error_response

Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
error	error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

session_properties

Vlastnosti relace vykreslování.

Name	Typ	Description
arrInspectorPort	integer	Port TCP, na kterém je hostovaný nástroj Azure Remote Rendering Inspector.
creationTime	string	Čas vytvoření relace vykreslování. Datum a čas ve formátu ISO 8601.
elapsedTimeMinutes	integer	Doba v minutách, po kterou je nebo byla relace ve stavu Připraveno. Čas se zaokrouhlí dolů na celou minutu.
error	error	Objekt chyby obsahující podrobnosti o selhání spuštění relace vykreslování.
handshakePort	integer	Port TCP použitý pro metodu handshake při navazování připojení.
hostname	string	Název hostitele, pod kterým je relace vykreslování dostupná.
id	string	ID relace zadané při vytvoření relace.
maxLeaseTimeMinutes	integer	Čas v minutách, kdy se relace spustí po dosažení stavu Připraveno.
size	session_size	Velikost serveru použitého pro relaci vykreslování. Velikost ovlivňuje počet mnohoúhelníku, které může server vykreslit. Podrobnosti najdete v tématu https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .
status	session_status	Stav relace vykreslování. Terminálové stavy jsou Error (Chyba), Expired (Platnost vypršela) a Stopped (Zastaveno).
teraflops	number	Výpočetní výkon gpu relace vykreslování měřený v teraflopech.

session_size

Velikost serveru použitého pro relaci vykreslování. Velikost ovlivňuje počet mnohoúhelníku, které může server vykreslit. Podrobnosti najdete v tématu https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

Name	Typ	Description
Premium	string	Velikost relace vykreslování úrovně Premium.
Standard	string	Standardní velikost relace vykreslování.

session_status

Stav relace vykreslování. Terminálové stavy jsou Error (Chyba), Expired (Platnost vypršela) a Stopped (Zastaveno).

Name	Typ	Description
Error	string	V relaci vykreslování došlo k chybě a je nepoužitelná. Jedná se o stav terminálu.
Expired	string	Relace vykreslování přejde do stavu "Platnost vypršela", pokud je ve stavu Připraveno déle, než je doba zapůjčení. Jedná se o stav terminálu.
Ready	string	Relace vykreslování je připravená pro příchozí připojení.
Starting	string	Relace vykreslování se spouští, ale zatím nepřijímá příchozí připojení.
Stopped	string	Relace vykreslování byla zastavena operací Zastavit relaci. Jedná se o stav terminálu.

Sdílet prostřednictvím