Remote Rendering - Stop Session

Referenz

Dienst:: Mixed Reality

API-Version:: 2021-01-01

Beendet eine bestimmte Renderingsitzung.

POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?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.

Antworten

Name	Typ	Beschreibung
204 No Content		NoContent. Die Beendigungsanforderung war erfolgreich. Die Renderingsitzung wird beendet. 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
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. Ein erneutes 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

Stop a session

Beispielanforderung

HTTP

POST https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28/:stop?api-version=2021-01-01

Beispiel für eine Antwort

Statuscode:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

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.

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.

Freigeben über