Remote Rendering - Update Session

Usługa:

Mixed Reality

Wersja interfejsu API:

2021-01-01

Aktualizuje maksymalny czas dzierżawy określonej sesji renderowania.

PATCH {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źć w 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ę Mixed Reality Secure Token Service. Aby uzyskać szczegółowe informacje, zobacz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Treść żądania

Nazwa	Wymagane	Typ	Opis
maxLeaseTimeMinutes	True	integer	Zaktualizuj do czasu uruchomienia sesji po osiągnięciu stanu "Gotowe". Musi być większa niż bieżąca wartość maxLeaseTimeMinutes i mniejsza niż 1440.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	session_properties	OK. Sesja została zaktualizowana.
401 Unauthorized		Nieautoryzowanych. Brak lub nieprawidłowa autoryzacja. Nagłówki MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakazany. 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
422 Unprocessable Entity	error_response	Nieprzetworzona jednostka. Wartość maxLeaseTimeMinutes była nieprawidłowa. Musi być większa niż bieżąca wartość maxLeaseTimeMinutes. 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ę Mixed Reality Secure Token Service. Aby uzyskać szczegółowe informacje, zobacz https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
W: header

Przykłady

Update a session

Przykładowe żądanie

HTTP

PATCH 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": 72
}

Przykładowa odpowiedź

Kod stanu:

200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "arrInspectorPort": 50052,
  "handshakePort": 50051,
  "elapsedTimeMinutes": 10,
  "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
  "maxLeaseTimeMinutes": 72,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}

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:

422

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

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 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 na potrzeby sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które może renderować serwer. Aby uzyskać szczegółowe informacje, zobacz https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
session_status	Stan sesji renderowania. Stany terminalu to "Error", "Expired" i "Stopped".
update_session_settings	Ustawienia używane do aktualizowania sesji.

error

Objekt

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

Objekt

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

Objekt

Właściwości sesji renderowania.

Nazwa	Typ	Opis
arrInspectorPort	integer minimum: 49152 maximum: 65534	Port TCP, na którym jest hostowane narzędzie Azure Remote Rendering Inspector.
creationTime	string (date-time)	Godzina utworzenia sesji renderowania. Data i godzina w formacie ISO 8601.
elapsedTimeMinutes	integer	Czas 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ółowe informacje o niepowodzeniu uruchamiania sesji renderowania.
handshakePort	integer minimum: 49152 maximum: 65534	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, w których sesja zostanie uruchomiona po osiągnięciu stanu "Gotowe".
size	session_size	Rozmiar serwera używanego na potrzeby sesji renderowania. Rozmiar ma wpływ na liczbę wielokątów, które może renderować serwer. Aby uzyskać szczegółowe informacje, zobacz https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
status	session_status	Stan sesji renderowania. Stany terminalu to "Error", "Expired" i "Stopped".
teraflops	number (float)	Moc obliczeniowa procesora GPU sesji renderowania mierzona w teraflops.

session_size

Wyliczanie

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

Wartość	Opis
Premium	Rozmiar sesji renderowania Premium.
Standard	Standardowy rozmiar sesji renderowania.

session_status

Wyliczanie

Stan sesji renderowania. Stany terminalu to "Error", "Expired" i "Stopped".

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

update_session_settings

Objekt

Ustawienia używane do aktualizowania sesji.

Nazwa	Typ	Opis
maxLeaseTimeMinutes	integer	Zaktualizuj do czasu uruchomienia sesji po osiągnięciu stanu "Gotowe". Musi być większa niż bieżąca wartość maxLeaseTimeMinutes i mniejsza niż 1440.