Remote Rendering - Create Session

Referenz

Dienst:: Mixed Reality

API-Version:: 2021-01-01

Erstellt eine neue Renderingsitzung.

PUT {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. Die ID beachtet die Groß-/Kleinschreibung, kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, 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.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
maxLeaseTimeMinutes	True	integer	Die Zeit in Minuten, die die Sitzung nach Erreichen des Zustands "Bereit" ausgeführt wird. Sie muss zwischen 0 und 1440 sein.
size	True	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.

Antworten

Name	Typ	Beschreibung
200 OK	session_properties	OK. Gibt an, dass bereits eine Sitzung mit den gleichen Einstellungen vorhanden war. Dies wird erwartet, wenn die Sitzungserstellung wiederholt wird.
201 Created	session_properties	Erstellt. Die Sitzung wurde erfolgreich erstellt. Header MS-CV: string
400 Bad Request	error_response	Ungültige Anforderung; Das zurückgegebene Fehlerobjekt beschreibt, welche Probleme aufgetreten sind. Header MS-CV: string
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
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. Ein erneutes Wiederholen der Anforderung kann zu erfolgreichen Ergebnissen führen. Header MS-CV: string
Other Status Codes	error_response	Konflikt. Für das Remoterenderkonto ist bereits eine Renderingsitzung mit der ID vorhanden.

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

Create a rendering session

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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
}

Statuscode:: 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
}

Statuscode:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuscode:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuscode:: 401

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

Statuscode:: 403

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
create_session_settings	Einstellungen der zu erstellenden Sitzung.
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	Der status der Renderingsitzung. Terminalzustände sind "Error", "Expired" und "Stopped".

create_session_settings

Einstellungen der zu erstellenden Sitzung.

Name	Typ	Beschreibung
maxLeaseTimeMinutes	integer	Die Zeit in Minuten, die die Sitzung nach Erreichen des Zustands "Bereit" ausgeführt wird. Sie muss zwischen 0 und 1440 sein.
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.

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 für Menschen 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	Zeitraum in Minuten, in dem sich die Sitzung im Zustand "Bereit" befindet oder sich befand. Die Zeit wird auf eine volle 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 Zustands "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	Der status der Renderingsitzung. Terminalzustände 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	Standard-Renderingsitzungsgröße.

session_status

Der status der Renderingsitzung. Terminalzustände sind "Error", "Expired" und "Stopped".

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

Freigeben über