Remote Rendering - Stop Session

Reference

Služba:: Mixed Reality

Verze rozhraní API:: 2021-01-01

Zastaví konkrétní relaci vykreslování.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
account_id	path	True	string uuid	ID účtu Azure Remote Rendering.
endpoint	path	True	string	Koncový bod, který se má použít, například https://remoterendering.eastus.mixedreality.azure.com. Seznam najdete na adrese https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	ID jednoznačně identifikující relaci vykreslování pro daný účet. V ID se rozlišují velká a malá písmena, může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítků a nesmí obsahovat více než 256 znaků.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Odpovědi

Name	Typ	Description
204 No Content		Bez obsahu. Žádost o zastavení byla úspěšná. Relace vykreslování je zastavená. Hlavičky MS-CV: string
401 Unauthorized		Neautorizováno Chybí nebo je autorizace neplatná. Hlavičky MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakázáno. Autorizace pro daný prostředek není dostatečná. Hlavičky MS-CV: string
404 Not Found		Nenalezena. Žádná relace se zadaným ID relace neexistuje. Hlavičky MS-CV: string
429 Too Many Requests		Příliš mnoho požadavků. Byl překročen limit přenosové rychlosti. Po uplynutí doby uvedené v hlavičce Retry-After zkuste požadavek zopakovat. Hlavičky MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Vnitřní chyba Na serveru došlo k vnitřní chybě. Opakování požadavku může vést k úspěšným výsledkům. Hlavičky MS-CV: string

Zabezpečení

Authorization

Nosný token vrácený službou zabezpečených tokenů Mixed Reality. Podrobnosti viz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
V: header

Příklady

Stop a session

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 401

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

Stavový kód:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Stavový kód:: 429

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

Stavový kód:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definice

Name	Description
error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.
error_response	Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.

error

Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
code	string	Kód chyby
details	error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innerError	error	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl konkrétní chyby (např. název vlastnosti v chybě).

error_response

Odpověď na chybu obsahující podrobnosti o tom, proč požadavek selhal.

Name	Typ	Description
error	error	Objekt chyby obsahující podrobnosti o tom, proč požadavek selhal.

Sdílet prostřednictvím