Remote Rendering - List Sessions
Pobiera listę wszystkich sesji renderowania.
GET {endpoint}/accounts/{account_id}/sessions?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. |
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. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. Zwraca listę sesji, które znajdują się w stanie "Uruchamianie" lub "Gotowe". |
|
401 Unauthorized |
Brak autoryzacji. Brak lub nieprawidłowa autoryzacja. Nagłówki
|
|
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
|
|
500 Internal Server Error |
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 |
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
List sessions
Przykładowe żądanie
GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions?api-version=2021-01-01
Przykładowa odpowiedź
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"sessions": [
{
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"arrInspectorPort": 50052,
"handshakePort": 50051,
"elapsedTimeMinutes": 59,
"hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Stopped",
"error": null,
"teraflops": 10.6
},
{
"id": "contoso-session-03c200ce-faf8-4238-8db9-872ac9dd501d",
"creationTime": "2021-01-01T11:11:11.111Z",
"arrInspectorPort": 50053,
"handshakePort": 50052,
"elapsedTimeMinutes": 12,
"hostname": "615854b8-1748-4f2e-9522-bf8523d7299c.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 72,
"size": "Standard",
"status": "Ready",
"error": null,
"teraflops": 10.6
}
]
}
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
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 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". |
sessions_list |
Wynik żądania sesji listy. |
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 |
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 |
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 |
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 |
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 |
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. |
sessions_list
Wynik żądania sesji listy.
Nazwa | Typ | Opis |
---|---|---|
@nextLink |
string |
Jeśli dostępne są więcej sesji renderowania, to pole będzie zawierać adres URL, pod którym można zażądać następnej partii sesji. Ten adres URL będzie wymagał tego samego uwierzytelniania co wszystkie wywołania interfejsu API usługi Azure Remote Rendering. |
sessions |
Lista sesji renderowania. Nie obejmuje sesji w stanie "Zatrzymano". |