Remote Rendering - Stop Session

Odwołanie

Usługa:: Mixed Reality

Wersja interfejsu API:: 2021-01-01

Zatrzymuje określoną sesję renderowania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
account_id	path	True	string uuid	Identyfikator konta usługi Azure Remote Rendering.
endpoint	path	True	string	Punkt końcowy do użycia, np. https://remoterendering.eastus.mixedreality.azure.com. Listę można znaleźć na stronie https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Identyfikator jednoznacznie identyfikujący sesję renderowania dla danego konta. W identyfikatorze jest rozróżniana wielkość liter, może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 256 znaków.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem HTTP.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego zwrócony przez usługę tokenu bezpiecznego Mixed Reality. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		NoContent. Żądanie zatrzymania zakończyło się pomyślnie. Sesja renderowania została zatrzymana. Nagłówki MS-CV: string
401 Unauthorized		Brak autoryzacji. Brak lub nieprawidłowa autoryzacja. Nagłówki MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakazane. Autoryzacja niewystarczająca dla danego zasobu. Nagłówki MS-CV: string
404 Not Found		Nie znaleziono. Nie istnieje żadna sesja z podanym identyfikatorem sesji. Nagłówki MS-CV: string
429 Too Many Requests		Zbyt wiele żądań. Przekroczono limit szybkości. Ponów próbę żądania po upływie czasu trwania podanego w nagłówku Retry-After. Nagłówki MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Błąd wewnętrzny. Serwer napotkał błąd wewnętrzny. Ponowienie próby żądania może spowodować pomyślne wyniki. Nagłówki MS-CV: string

Zabezpieczenia

Authorization

Token elementu nośnego zwrócony przez usługę tokenu bezpiecznego Mixed Reality. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
W: header

Przykłady

Stop a session

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

Kod stanu:: 401

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

Kod stanu:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Kod stanu:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Kod stanu:: 429

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

Kod stanu:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definicje

Nazwa	Opis
error	Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.
error_response	Odpowiedź o błędzie zawierająca szczegółowe informacje o przyczynie niepowodzenia żądania.

error

Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError	error	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy określonego błędu (np. nazwa właściwości w błędzie).

error_response

Odpowiedź o błędzie zawierająca szczegółowe informacje o przyczynie niepowodzenia żądania.

Nazwa	Typ	Opis
error	error	Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.

Udostępnij za pośrednictwem