Remote Rendering - Get Session

참조

서비스:: Mixed Reality

API 버전:: 2021-01-01

특정 렌더링 세션의 속성을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
account_id	path	True	string (uuid)	Azure Remote Rendering 계정 ID입니다.
endpoint	path	True	string	사용할 엔드포인트(예: https://remoterendering.eastus.mixedreality.azure.com)입니다. 목록은 https://docs.microsoft.com/azure/remote-rendering/reference/regions찾을 수 있습니다.
session_id	path	True	string	지정된 계정에 대한 렌더링 세션을 고유하게 식별하는 ID입니다. ID는 대/소문자를 구분하며 하이픈과 밑줄을 포함한 영숫자 문자를 조합하여 포함할 수 있으며 256자를 초과할 수 없습니다.
api-version	query	True	string	HTTP 요청과 함께 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Authorization	True	string	Mixed Reality Secure Token Service에서 반환된 전달자 토큰입니다. 자세한 내용은 https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens 참조하세요.

응답

Name	형식	Description
200 OK	session_properties	그래.
401 Unauthorized		무단. 누락되었거나 잘못된 권한 부여입니다. 헤더 MS-CV: string WWW-Authenticate: string
403 Forbidden		금지된. 지정된 리소스에 대한 권한 부여가 부족합니다. 헤더 MS-CV: string
404 Not Found		찾을 수 없습니다. 제공된 세션 ID가 있는 세션이 없습니다. 헤더 MS-CV: string
429 Too Many Requests		요청이 너무 많습니다. 속도 제한을 초과했습니다. Retry-After 헤더에 지정된 기간 후에 요청을 다시 시도합니다. 헤더 MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	내부 오류입니다. 서버에 내부 오류가 발생했습니다. 요청을 다시 시도하면 성공적인 결과가 생성됩니다. 헤더 MS-CV: string

보안

Authorization

Mixed Reality Secure Token Service에서 반환된 전달자 토큰입니다. 자세한 내용은 https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens 참조하세요.

형식: apiKey
In(다음 안에): header

예제

Get a previously created session by ID

샘플 요청

HTTP

GET 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

샘플 응답

상태 코드:: 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": 60,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}

상태 코드:: 401

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

상태 코드:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

상태 코드:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

상태 코드:: 429

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

상태 코드:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

정의

Name	Description
error	요청이 실패한 이유에 대한 세부 정보를 포함하는 오류 개체입니다.
error_response	요청이 실패한 이유에 대한 세부 정보가 포함된 오류 응답입니다.
session_properties	렌더링 세션의 속성입니다.
session_size	렌더링 세션에 사용되는 서버의 크기입니다. 크기는 서버에서 렌더링할 수 있는 다각형의 수에 영향을 줍니다. 자세한 내용은 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 참조하세요.
session_status	렌더링 세션의 상태입니다. 터미널 상태는 'Error', 'Expired' 및 'Stopped'입니다.

error

Object

요청이 실패한 이유에 대한 세부 정보를 포함하는 오류 개체입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innerError	error	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	특정 오류의 대상(예: 오류의 속성 이름)입니다.

error_response

Object

요청이 실패한 이유에 대한 세부 정보가 포함된 오류 응답입니다.

Name	형식	Description
error	error	요청이 실패한 이유에 대한 세부 정보를 포함하는 오류 개체입니다.

session_properties

Object

렌더링 세션의 속성입니다.

Name	형식	Description
arrInspectorPort	integer minimum: 49152 maximum: 65534	Azure Remote Rendering Inspector 도구가 호스트되는 TCP 포트입니다.
creationTime	string (date-time)	렌더링 세션이 만들어진 시간입니다. ISO 8601 형식의 날짜 및 시간입니다.
elapsedTimeMinutes	integer	세션이 '준비' 상태이거나 상태인 시간(분)입니다. 시간은 전체 분으로 반올림됩니다.
error	error	렌더링 세션 시작 실패에 대한 세부 정보를 포함하는 오류 개체입니다.
handshakePort	integer minimum: 49152 maximum: 65534	연결을 설정할 때 핸드셰이크에 사용되는 TCP 포트입니다.
hostname	string	렌더링 세션에 연결할 수 있는 호스트 이름입니다.
id	string	세션을 만들 때 제공된 세션의 ID입니다.
maxLeaseTimeMinutes	integer	'준비' 상태에 도달한 후 세션이 실행되는 시간(분)입니다.
size	session_size	렌더링 세션에 사용되는 서버의 크기입니다. 크기는 서버에서 렌더링할 수 있는 다각형의 수에 영향을 줍니다. 자세한 내용은 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 참조하세요.
status	session_status	렌더링 세션의 상태입니다. 터미널 상태는 'Error', 'Expired' 및 'Stopped'입니다.
teraflops	number (float)	teraflops로 측정된 렌더링 세션 GPU의 계산 능력입니다.

session_size

열거형

렌더링 세션에 사용되는 서버의 크기입니다. 크기는 서버에서 렌더링할 수 있는 다각형의 수에 영향을 줍니다. 자세한 내용은 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 참조하세요.

값	Description
Premium	프리미엄 렌더링 세션 크기입니다.
Standard	표준 렌더링 세션 크기입니다.

session_status

열거형

렌더링 세션의 상태입니다. 터미널 상태는 'Error', 'Expired' 및 'Stopped'입니다.

값	Description
Error	렌더링 세션에 오류가 발생하여 사용할 수 없습니다. 터미널 상태입니다.
Expired	렌더링 세션이 임대 시간보다 더 긴 '준비' 상태에 있으면 '만료됨' 상태가 됩니다. 터미널 상태입니다.
Ready	렌더링 세션이 들어오는 연결에 대해 준비되었습니다.
Starting	렌더링 세션이 시작되지만 아직 들어오는 연결을 허용하지 않습니다.
Stopped	'세션 중지' 작업으로 렌더링 세션이 중지되었습니다. 터미널 상태입니다.

다음을 통해 공유

Remote Rendering - Get Session

URI 매개 변수

요청 헤더

응답

보안

Authorization

예제

Get a previously created session by ID

샘플 요청

샘플 응답

정의

error

error_response

session_properties

session_size

session_status

추가 리소스