Remote Rendering - Update Session

Tjänst:

Mixed Reality

API-version:

2021-01-01

Uppdaterar den maximala lånetiden för en viss återgivningssession.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
account_id	path	True	string (uuid)	Konto-ID för Azure Remote Rendering.
endpoint	path	True	string	Slutpunkten som ska användas, t.ex. https://remoterendering.eastus.mixedreality.azure.com. En lista finns på https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Ett ID som unikt identifierar återgivningssessionen för det angivna kontot. ID:t är skiftlägeskänsligt, kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 256 tecken.
api-version	query	True	string	DEN API-version som ska användas med HTTP-begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Begärandetext

Name	Obligatorisk	Typ	Description
maxLeaseTimeMinutes	True	integer	Uppdatera till den tid då sessionen körs efter att den har nått tillståndet "Klar". Den måste vara större än det aktuella värdet för maxLeaseTimeMinutes och mindre än 1440.

Svar

Name	Typ	Description
200 OK	session_properties	OKEJ. Sessionen har uppdaterats.
401 Unauthorized		Obehörig. Auktorisering saknas eller är ogiltig. Sidhuvuden MS-CV: string WWW-Authenticate: string
403 Forbidden		Förbjuden. Auktoriseringen är otillräcklig för den angivna resursen. Sidhuvuden MS-CV: string
404 Not Found		Hittades inte. Det finns ingen session med det angivna sessions-ID:t. Sidhuvuden MS-CV: string
422 Unprocessable Entity	error_response	Entitet som inte kan bearbetas. MaxLeaseTimeMinutes-värdet var ogiltigt. Den måste vara större än det aktuella värdet för maxLeaseTimeMinutes. Sidhuvuden MS-CV: string
429 Too Many Requests		För många begäranden. Hastighetsgränsen har överskridits. Försök igen efter varaktigheten som anges i Retry-After-huvudet. Sidhuvuden MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Internt fel. Servern har påträffat ett internt fel. Ett nytt försök med begäran kan ge lyckade resultat. Sidhuvuden MS-CV: string

Säkerhet

Authorization

En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
I: header

Exempel

Update a session

Exempelbegäran

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
}

Exempelsvar

Statuskod:

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
}

Statuskod:

401

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

Statuskod:

403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuskod:

404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuskod:

422

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuskod:

429

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

Statuskod:

500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definitioner

Name	Description
error	Felobjektet som innehåller information om varför begäran misslyckades.
error_response	Felsvaret innehåller information om varför begäran misslyckades.
session_properties	Egenskaperna för en återgivningssession.
session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".
update_session_settings	Inställningar som används för att uppdatera sessionen.

error

Objekt

Felobjektet som innehåller information om varför begäran misslyckades.

Name	Typ	Description
code	string	Felkod.
details	error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innerError	error	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för det specifika felet (t.ex. namnet på egenskapen i fel).

error_response

Objekt

Felsvaret innehåller information om varför begäran misslyckades.

Name	Typ	Description
error	error	Felobjektet som innehåller information om varför begäran misslyckades.

session_properties

Objekt

Egenskaperna för en återgivningssession.

Name	Typ	Description
arrInspectorPort	integer minimum: 49152 maximum: 65534	TCP-porten där verktyget Azure Remote Rendering Inspector finns.
creationTime	string (date-time)	Tiden då återgivningssessionen skapades. Datum och tid i ISO 8601-format.
elapsedTimeMinutes	integer	Hur lång tid i minuter sessionen är eller var i tillståndet "Redo". Tiden avrundas ned till en hel minut.
error	error	Felobjektet som innehåller information om återgivningssessionens startfel.
handshakePort	integer minimum: 49152 maximum: 65534	TCP-porten som används för handskakningen när du upprättar en anslutning.
hostname	string	Värdnamnet under vilket återgivningssessionen kan nås.
id	string	ID för den session som angavs när sessionen skapades.
maxLeaseTimeMinutes	integer	Tiden i minuter sessionen körs efter att ha nått tillståndet "Redo".
size	session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
status	session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".
teraflops	number (float)	Beräkningskraften för återgivningssessionens GPU mätt i teraflops.

session_size

Uppräkning

Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Värde	Description
Premium	Sessionsstorlek för Premium-rendering.
Standard	Standardåtergivning av sessionsstorlek.

session_status

Uppräkning

Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".

Värde	Description
Error	Renderingssessionen har påträffat ett fel och kan inte användas. Det här är ett terminaltillstånd.
Expired	Renderingssessionen anger tillståndet "Har upphört att gälla" när den har varit i tillståndet "Klar" längre än dess lånetid. Det här är ett terminaltillstånd.
Ready	Återgivningssessionen är redo för inkommande anslutningar.
Starting	Återgivningssessionen startar men accepterar inte inkommande anslutningar ännu.
Stopped	Återgivningssessionen har stoppats med åtgärden "Stoppa session". Det här är ett terminaltillstånd.

update_session_settings

Objekt

Inställningar som används för att uppdatera sessionen.

Name	Typ	Description
maxLeaseTimeMinutes	integer	Uppdatera till den tid då sessionen körs efter att den har nått tillståndet "Klar". Den måste vara större än det aktuella värdet för maxLeaseTimeMinutes och mindre än 1440.