Remote Rendering - Stop Session

Referentie

Service:: Mixed Reality

API-versie:: 2021-01-01

Stopt een bepaalde renderingsessie.

POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?api-version=2021-01-01

URI-parameters

Name	In	Vereist	Type	Description
account_id	path	True	string uuid	De account-id van de Azure Remote Rendering.
endpoint	path	True	string	Het eindpunt dat moet worden gebruikt, bijvoorbeeld https://remoterendering.eastus.mixedreality.azure.com. Een lijst vindt u op https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Een id die de renderingsessie voor het opgegeven account uniek identificeert. De id is hoofdlettergevoelig, kan een willekeurige combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 256 tekens bevatten.
api-version	query	True	string	De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Antwoorden

Name	Type	Description
204 No Content		NoContent. De stopaanvraag is geslaagd. De renderingsessie is gestopt. Kopteksten MS-CV: string
401 Unauthorized		Onbevoegd. Ontbrekende of ongeldige autorisatie. Kopteksten MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboden. Autorisatie is onvoldoende voor de opgegeven resource. Kopteksten MS-CV: string
404 Not Found		Niet gevonden. Er bestaat geen sessie met de opgegeven sessie-id. Kopteksten MS-CV: string
429 Too Many Requests		Te veel aanvragen. De frequentielimiet is overschreden. Voer de aanvraag opnieuw uit na de duur die is opgegeven in de Retry-After-header. Kopteksten MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interne fout. Er is een interne fout opgetreden op de server. Het opnieuw proberen van de aanvraag kan resultaten opleveren. Kopteksten MS-CV: string

Beveiliging

Authorization

Een Bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Type: apiKey
In: header

Voorbeelden

Stop a session

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
error	Het foutobject met details over waarom de aanvraag is mislukt.
error_response	Het foutbericht met details over waarom de aanvraag is mislukt.

error

Het foutobject met details over waarom de aanvraag is mislukt.

Name	Type	Description
code	string	Foutcode.
details	error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innerError	error	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap met fout).

error_response

Het foutbericht met details over waarom de aanvraag is mislukt.

Name	Type	Description
error	error	Het foutobject met details over waarom de aanvraag is mislukt.

Delen via