Remote Rendering - Get Session

Referenz

Dienst:: Mixed Reality

API-Version:: 2021-01-01

Ruft die Eigenschaften einer bestimmten Renderingsitzung ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
account_id	path	True	string uuid	Die Azure Remote Rendering-Konto-ID.
endpoint	path	True	string	Der zu verwendende Endpunkt, z. B. https://remoterendering.eastus.mixedreality.azure.com. Eine Liste finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Eine ID, die die Renderingsitzung für das angegebene Konto eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beachtet, kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 256 Zeichen enthalten.
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Antworten

Name	Typ	Beschreibung
200 OK	session_properties	OK.
401 Unauthorized		Nicht autorisiert. Fehlende oder ungültige Autorisierung. Header MS-CV: string WWW-Authenticate: string
403 Forbidden		Unzulässig. Die Autorisierung reicht für eine bestimmte Ressource nicht aus. Header MS-CV: string
404 Not Found		Nicht gefunden: Es ist keine Sitzung mit der angegebenen Sitzungs-ID vorhanden. Header MS-CV: string
429 Too Many Requests		Zu viele Anforderungen. Das Ratenlimit wurde überschritten. Wiederholen Sie die Anforderung nach der im Retry-After-Header angegebenen Dauer. Header MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interner Fehler. Beim Server ist ein interner Fehler aufgetreten. Das Wiederholen der Anforderung kann zu erfolgreichen Ergebnissen führen. Header MS-CV: string

Sicherheit

Authorization

Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Einzelheiten dazu finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
In: header

Beispiele

Get a previously created session by ID

Beispielanforderung

HTTP

GET 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

Beispiel für eine Antwort

Statuscode:: 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": 60,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}

Statuscode:: 401

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

Statuscode:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 429

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

Statuscode:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definitionen

Name	Beschreibung
error	Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.
error_response	Die Fehlerantwort, die Details dazu enthält, warum die Anforderung fehlgeschlagen ist.
session_properties	Die Eigenschaften einer Renderingsitzung.
session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes finden Sie entsprechende Einzelheiten.
session_status	Die status der Renderingsitzung. Die Terminalstatus sind "Error", "Expired" und "Stopped".

error

Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
code	string	Fehlercode
details	error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	error	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des jeweiligen Fehlers (z. B. der Name der -Eigenschaft im Fehler).

error_response

Die Fehlerantwort, die Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
error	error	Das Fehlerobjekt, das Details dazu enthält, warum die Anforderung fehlgeschlagen ist.

session_properties

Die Eigenschaften einer Renderingsitzung.

Name	Typ	Beschreibung
arrInspectorPort	integer	Der TCP-Port, an dem das Azure Remote Rendering Inspector-Tool gehostet wird.
creationTime	string	Der Zeitpunkt, zu dem die Renderingsitzung erstellt wurde. Datum und Uhrzeit im ISO 8601-Format.
elapsedTimeMinutes	integer	Die Zeitspanne in Minuten, in der die Sitzung den Status "Bereit" aufweist oder sich im Zustand befand. Die Zeit wird auf eine ganze Minute gerundet.
error	error	Das Fehlerobjekt, das Details zum Startfehler der Renderingsitzung enthält.
handshakePort	integer	Der TCP-Port, der für den Handshake beim Herstellen einer Verbindung verwendet wird.
hostname	string	Der Hostname, unter dem die Renderingsitzung erreichbar ist.
id	string	Die ID der Sitzung, die beim Erstellen der Sitzung angegeben wurde.
maxLeaseTimeMinutes	integer	Die Zeit in Minuten, die die Sitzung nach Erreichen des Status "Bereit" ausgeführt wird.
size	session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes finden Sie entsprechende Einzelheiten.
status	session_status	Die status der Renderingsitzung. Die Terminalstatus sind "Error", "Expired" und "Stopped".
teraflops	number	Die In Teraflops gemessene Rechenleistung der GPU der Renderingsitzung.

session_size

Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes finden Sie entsprechende Einzelheiten.

Name	Typ	Beschreibung
Premium	string	Premium-Renderingsitzungsgröße.
Standard	string	Standardgröße der Renderingsitzung.

session_status

Die status der Renderingsitzung. Die Terminalstatus sind "Error", "Expired" und "Stopped".

Name	Typ	Beschreibung
Error	string	Bei der Renderingsitzung ist ein Fehler aufgetreten und nicht verwendbar. Dies ist ein Endzustand.
Expired	string	Die Renderingsitzung wechselt in den Zustand "Abgelaufen", wenn sie sich länger als die Leasezeit im Zustand "Bereit" befindet. Dies ist ein Endzustand.
Ready	string	Die Renderingsitzung ist für eingehende Verbindungen bereit.
Starting	string	Die Renderingsitzung wird gestartet, akzeptiert aber noch keine eingehenden Verbindungen.
Stopped	string	Die Renderingsitzung wurde mit dem Vorgang "Sitzung beenden" beendet. Dies ist ein Endzustand.

Freigeben über