Remote Rendering - List Sessions

Referens

Tjänst:: Mixed Reality

API-version:: 2021-01-01

Hämtar en lista över alla renderingssessioner.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
account_id	path	True	string uuid	Konto-ID:t 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.
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 Mixed Reality Secure Token Service. Mer information finns under https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Svar

Name	Typ	Description
200 OK	sessions_list	OK. Returnerar listan över sessioner som är i tillståndet "Start" eller "Klar".
401 Unauthorized		Behörighet saknas. Auktorisering saknas eller är ogiltig. Sidhuvuden MS-CV: string WWW-Authenticate: string
403 Forbidden		Förbjudet. Auktoriseringen är otillräcklig för den angivna resursen. Sidhuvuden MS-CV: string
429 Too Many Requests		För många begäranden. Hastighetsgränsen har överskridits. Försök igen efter varaktigheten 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 Mixed Reality Secure Token Service. Mer information finns under https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
I: header

Exempel

List sessions

Exempelbegäran

HTTP

GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions?api-version=2021-01-01

Exempelsvar

Statuskod:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "sessions": [
    {
      "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
      "creationTime": "2020-11-11T11:11:11.111Z",
      "arrInspectorPort": 50052,
      "handshakePort": 50051,
      "elapsedTimeMinutes": 59,
      "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
      "maxLeaseTimeMinutes": 60,
      "size": "Standard",
      "status": "Stopped",
      "error": null,
      "teraflops": 10.6
    },
    {
      "id": "contoso-session-03c200ce-faf8-4238-8db9-872ac9dd501d",
      "creationTime": "2021-01-01T11:11:11.111Z",
      "arrInspectorPort": 50053,
      "handshakePort": 50052,
      "elapsedTimeMinutes": 12,
      "hostname": "615854b8-1748-4f2e-9522-bf8523d7299c.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:: 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. https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes Mer information finns i.
session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".
sessions_list	Resultatet av en begäran om listsessioner.

error

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 läsbar återgivning av felet.
target	string	Målet för det specifika felet (t.ex. namnet på egenskapen i fel).

error_response

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

Egenskaperna för en återgivningssession.

Name	Typ	Description
arrInspectorPort	integer	TCP-porten där Azure Remote Rendering Inspector-verktyget finns.
creationTime	string	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 "Klar". Tiden avrundas ned till en hel minut.
error	error	Felobjektet som innehåller information om återgivningssessionens startfel.
handshakePort	integer	TCP-porten som används för handskakningen när en anslutning upprättas.
hostname	string	Värdnamnet under vilket återgivningssessionen kan nås.
id	string	ID:t för sessionen som angavs när sessionen skapades.
maxLeaseTimeMinutes	integer	Tiden i minuter som sessionen körs när statusen "Klar" har nåtts.
size	session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes Mer information finns i.
status	session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".
teraflops	number	Beräkningskraften för återgivningssessionens GPU mätt i teraflops.

session_size

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

Name	Typ	Description
Premium	string	Sessionsstorlek för Premium-rendering.
Standard	string	Standardåtergivningssessionsstorlek.

session_status

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

Name	Typ	Description
Error	string	Återgivningssessionen har påträffat ett fel och kan inte användas. Det här är ett terminaltillstånd.
Expired	string	Återgivningssessionen anger tillståndet "Förfallen" när den har varit i tillståndet "Klar" längre än sin lånetid. Det här är ett terminaltillstånd.
Ready	string	Återgivningssessionen är klar för inkommande anslutningar.
Starting	string	Återgivningssessionen startar, men accepterar inte inkommande anslutningar ännu.
Stopped	string	Återgivningssessionen har stoppats med åtgärden "Stoppa session". Det här är ett terminaltillstånd.

sessions_list

Resultatet av en begäran om listsessioner.

Name	Typ	Description
@nextLink	string	Om fler återgivningssessioner är tillgängliga innehåller det här fältet en URL där nästa batch sessioner kan begäras. Den här URL:en behöver samma autentisering som alla anrop till Azure Remote Rendering-API:et.
sessions	session_properties[]	Listan över återgivningssessioner. Inkluderar inte sessioner i tillståndet Stoppad.

Dela via