Remote Rendering - List Sessions

Service:: Mixed Reality

API Version:: 2021-01-01

Gets a list of all rendering sessions.

GET {endpoint}/accounts/{account_id}/sessions?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
account_id	path	True	string (uuid)	The Azure Remote Rendering account ID.
endpoint	path	True	string	The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	The API version to be used with the HTTP request.

Request Header

Name	Required	Type	Description
Authorization	True	string	A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details.

Responses

Name	Type	Description
200 OK	sessions_list	OK. Returns the list of sessions which are in a 'Starting' or 'Ready' state.
401 Unauthorized		Unauthorized. Missing or invalid authorization. Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Forbidden. Authorization insufficient for given resource. Headers MS-CV: string
429 Too Many Requests		Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header. Headers MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Internal Error. Server has encountered an internal error. Retrying the request may produce successful results. Headers MS-CV: string

Security

Authorization

A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details.

Type: apiKey
In: header

Examples

List sessions

Sample request

HTTP

GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions?api-version=2021-01-01

Sample response

Status code:: 200

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

Status code:: 401

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

Status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 429

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

Status code:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definitions

Name	Description
error	The error object containing details of why the request failed.
error_response	The error response containing details of why the request failed.
session_properties	The properties of a rendering session.
session_size	The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details.
session_status	The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'.
sessions_list	The result of a list sessions request.

error

Object

The error object containing details of why the request failed.

Name	Type	Description
code	string	Error code.
details	error[]	An array of details about specific errors that led to this reported error.
innerError	error	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the particular error (e.g., the name of the property in error).

error_response

Object

The error response containing details of why the request failed.

Name	Type	Description
error	error	The error object containing details of why the request failed.

session_properties

Object

The properties of a rendering session.

Name	Type	Description
arrInspectorPort	integer minimum: 49152 maximum: 65534	The TCP port at which the Azure Remote Rendering Inspector tool is hosted.
creationTime	string (date-time)	The time when the rendering session was created. Date and time in ISO 8601 format.
elapsedTimeMinutes	integer	Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute.
error	error	The error object containing details about the rendering session startup failure.
handshakePort	integer minimum: 49152 maximum: 65534	The TCP port used for the handshake when establishing a connection.
hostname	string	The hostname under which the rendering session is reachable.
id	string	The ID of the session supplied when the session was created.
maxLeaseTimeMinutes	integer	The time in minutes the session will run after reaching the 'Ready' state.
size	session_size	The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details.
status	session_status	The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'.
teraflops	number (float)	The computational power of the rendering session GPU measured in teraflops.

session_size

Enumeration

The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details.

Value	Description
Standard	Standard rendering session size.
Premium	Premium rendering session size.

session_status

Enumeration

The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'.

Value	Description
Error	The rendering session has encountered an error, and is unusable. This is a terminal state.
Expired	The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state.
Starting	The rendering session is starting, but not accepting incoming connections yet.
Ready	The rendering session is ready for incoming connections.
Stopped	The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state.

sessions_list

Object

The result of a list sessions request.

Name	Type	Description
@nextLink	string	If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.
sessions	session_properties[]	The list of rendering sessions. Does not include sessions in 'Stopped' state.

Share via

Remote Rendering - List Sessions

URI Parameters

Request Header

Responses

Security

Authorization

Examples

List sessions

Sample request

Sample response

Definitions

error

error_response

session_properties

session_size

session_status

sessions_list