Remote Rendering - Create Session

Odwołanie

Usługa:: Mixed Reality

Wersja interfejsu API:: 2021-01-01

Tworzy nową sesję renderowania.

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?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źć pod adresem https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Identyfikator jednoznacznie identyfikujący sesję renderowania dla danego konta. Identyfikator uwzględnia 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 do użycia 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.

Treść żądania

Nazwa	Wymagane	Typ	Opis
maxLeaseTimeMinutes	True	integer	Czas w minutach sesji zostanie uruchomiony po osiągnięciu stanu "Gotowe". Musi to być od 0 do 1440.
size	True	session_size	Rozmiar serwera używanego do sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które serwer może renderować. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

Odpowiedzi

Nazwa	Typ	Opis
200 OK	session_properties	OK. Wskazuje, że była już sesja z tymi samymi ustawieniami. Jest to oczekiwane po ponownym pobraniu tworzenia sesji.
201 Created	session_properties	Utworzone. Sesja została pomyślnie utworzona. Nagłówki MS-CV: string
400 Bad Request	error_response	Nieprawidłowe żądanie. Zwrócony obiekt błędu opisuje, które problemy wystąpiły. 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
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. Ponawianie próby żądania może spowodować pomyślne wyniki. Nagłówki MS-CV: string
Other Status Codes	error_response	Konflikt. Sesja renderowania o identyfikatorze już istnieje dla konta renderowania zdalnego.

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

Create a rendering session

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
}

Kod stanu:: 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
}

Kod stanu:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Kod stanu:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Kod stanu:: 401

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

Kod stanu:: 403

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
create_session_settings	Ustawienia sesji do utworzenia.
error	Obiekt błędu zawierający szczegółowe informacje o tym, dlaczego żądanie nie powiodło się.
error_response	Odpowiedź o błędzie zawierająca szczegóły przyczyny niepowodzenia żądania.
session_properties	Właściwości sesji renderowania.
session_size	Rozmiar serwera używanego do sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które serwer może renderować. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .
session_status	Stan sesji renderowania. Stany terminalu to "Błąd", "Wygasły" i "Zatrzymany".

create_session_settings

Ustawienia sesji do utworzenia.

Nazwa	Typ	Opis
maxLeaseTimeMinutes	integer	Czas w minutach sesji zostanie uruchomiony po osiągnięciu stanu "Gotowe". Musi to być od 0 do 1440.
size	session_size	Rozmiar serwera używanego do sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które serwer może renderować. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

error

Obiekt błędu zawierający szczegółowe informacje o tym, dlaczego żądanie nie powiodło się.

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óły przyczyny niepowodzenia żądania.

Nazwa	Typ	Opis
error	error	Obiekt błędu zawierający szczegółowe informacje o tym, dlaczego żądanie nie powiodło się.

session_properties

Właściwości sesji renderowania.

Nazwa	Typ	Opis
arrInspectorPort	integer	Port TCP, na którym jest hostowane narzędzie Azure Remote Rendering Inspector.
creationTime	string	Godzina utworzenia sesji renderowania. Data i godzina w formacie ISO 8601.
elapsedTimeMinutes	integer	Ilość czasu w minutach, w których sesja jest w stanie "Gotowe". Czas jest zaokrąglany do pełnej minuty.
error	error	Obiekt błędu zawierający szczegóły dotyczące niepowodzenia uruchamiania sesji renderowania.
handshakePort	integer	Port TCP używany do uzgadniania podczas nawiązywania połączenia.
hostname	string	Nazwa hosta, w ramach której sesja renderowania jest osiągalna.
id	string	Identyfikator sesji podanej podczas tworzenia sesji.
maxLeaseTimeMinutes	integer	Czas w minutach sesji zostanie uruchomiony po osiągnięciu stanu "Gotowe".
size	session_size	Rozmiar serwera używanego do sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które serwer może renderować. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .
status	session_status	Stan sesji renderowania. Stany terminalu to "Błąd", "Wygasły" i "Zatrzymany".
teraflops	number	Moc obliczeniowa procesora GPU sesji renderowania mierzona w teraflops.

session_size

Rozmiar serwera używanego do sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które serwer może renderować. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes .

Nazwa	Typ	Opis
Premium	string	Rozmiar sesji renderowania w warstwie Premium.
Standard	string	Standardowy rozmiar sesji renderowania.

session_status

Stan sesji renderowania. Stany terminalu to "Błąd", "Wygasły" i "Zatrzymany".

Nazwa	Typ	Opis
Error	string	Sesja renderowania napotkała błąd i jest bezużyteczna. Jest to stan terminalu.
Expired	string	Sesja renderowania wprowadza stan "Wygasłe", gdy jest w stanie "Gotowe" dłużej niż jego czas dzierżawy. Jest to stan terminalu.
Ready	string	Sesja renderowania jest gotowa do połączeń przychodzących.
Starting	string	Sesja renderowania jest uruchamiana, ale nie akceptuje jeszcze połączeń przychodzących.
Stopped	string	Sesja renderowania została zatrzymana z operacją "Zatrzymaj sesję". Jest to stan terminalu.

Udostępnij za pośrednictwem