Remote Rendering - Update Session

Reference

Služba:: Mixed Reality

Verze rozhraní API:: 2021-01-01

Aktualizace maximální dobu zapůjčení konkrétní relace vykreslování.

PATCH {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	Aktualizujte na čas, kdy se relace spustí po dosažení stavu Připraveno. Musí být větší než aktuální hodnota maxLeaseTimeMinutes a menší než 1440.

Odpovědi

Name	Typ	Description
200 OK	session_properties	OK. Relace byla aktualizována.
401 Unauthorized		Neautorizováno Chybí nebo je autorizace neplatná. Hlavičky MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakázáno. Autorizace pro daný prostředek není dostatečná. Hlavičky MS-CV: string
404 Not Found		Nenalezena. Žádná relace se zadaným ID relace neexistuje. Hlavičky MS-CV: string
422 Unprocessable Entity	error_response	Nezpracovatelná entita. Hodnota maxLeaseTimeMinutes byla neplatná. Musí být větší než aktuální hodnota maxLeaseTimeMinutes. 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 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

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

Update a session

Ukázkový požadavek

HTTP

PATCH 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": 72
}

Ukázková odpověď

Stavový kód:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "arrInspectorPort": 50052,
  "handshakePort": 50051,
  "elapsedTimeMinutes": 10,
  "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
  "maxLeaseTimeMinutes": 72,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}

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:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 422

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

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
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íků, které může server vykreslit. Podrobnosti najdete v části 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).
update_session_settings	Nastavení používaná k aktualizaci relace.

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 nástroj Azure Remote Rendering Inspector hostovaný.
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íků, které může server vykreslit. Podrobnosti najdete v části 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 teraflops.

session_size

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

Name	Typ	Description
Premium	string	Velikost relace vykreslování 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á. Toto je terminální stav.
Expired	string	Relace vykreslování přejde do stavu Vypršení platnosti, pokud je ve stavu Připraveno déle, než je doba zapůjčení. Toto je terminální stav.
Ready	string	Relace vykreslování je připravená pro příchozí připojení.
Starting	string	Relace vykreslování se spouští, ale ještě nepřijímá příchozí připojení.
Stopped	string	Relace vykreslování byla zastavena operací Zastavit relaci. Toto je terminální stav.

update_session_settings

Nastavení používaná k aktualizaci relace.

Name	Typ	Description
maxLeaseTimeMinutes	integer	Aktualizujte na čas, kdy se relace spustí po dosažení stavu Připraveno. Musí být větší než aktuální hodnota maxLeaseTimeMinutes a menší než 1440.

Sdílet prostřednictvím