콘텐츠로 이동

createDeviceDisplaySession

POST
/api/v1/devices/{device_id}/display/sessions
curl --request POST \
--url https://dev.api.endueos.com/api/v1/devices/res_01J9ZK3Q8M4XW7D2N5R6T0V1BC/display/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "mode": "view" }'

Device 의 실시간 화면 세션을 연다. 깨우지 않는다 — 기기가 붙어 있지 않으면 소켓이 기다리다가(60초) 4408 로 닫힌다. linux 만. 다른 kind 는 422 DISPLAY_UNSUPPORTED. 에이전트에 디스플레이가 없으면 소켓이 4422 로 닫힌다. 사용자 JWT · Station API 키 · OAuth devices:control.

device_id
필수

Device 의 id — Resource 와 같은 res_ 다 (v0.1.0 이 이미 냈다).

string
/^res_[0-9A-HJKMNP-TV-Z]{26}$/
예시
res_01J9ZK3Q8M4XW7D2N5R6T0V1BC
Media typeapplication/json
object
mode

기본 view.

string
허용 값: view control

비밀값이 든 응답 — 캐시하지 않는다.

Media typeapplication/json
object
data
필수

화면 세션. 클라이언트는 wss://{API host}{socket_path}?ticket={ticket} 에 붙는다 — 응답에 origin 을 싣지 않는다 (이벤트 소켓과 같다). 소켓의 바이너리 프레임이 곧 RFB(3.8) 바이트다. noVNC RFB 에 그 주소를 그대로 준다.

object
display_session_id
필수

화면 세션 — dsp_ + ULID. DB 에 남지 않는다 (relay-service 의 Durable Object 이름, 만든 뒤 60분).

string
/^dsp_[0-9A-HJKMNP-TV-Z]{26}$/
device_id
필수

Device 의 id — Resource 와 같은 res_ 다 (v0.1.0 이 이미 냈다).

string
/^res_[0-9A-HJKMNP-TV-Z]{26}$/
workspace_id
필수
Any of:
string
/^wsp_[0-9A-HJKMNP-TV-Z]{26}$/
mode
필수

만들 때 정하고 바뀌지 않는다. 바꾸려면 새 세션을 연다.

string
허용 값: view control
protocol
필수

소켓 위의 프로토콜 — RFB over WebSocket (바이너리).

string
허용 값: rfb
socket_path
필수

/api/v1/display/sessions/{display_session_id}/socket

string
ticket
필수

osdt_ + hex 64. 한 번 쓰면 끝, ticket_expires_at 전에 붙어야 한다 (60초).

string
ticket_expires_at
필수
string format: date-time
expires_at
필수

세션이 끝나는 시각 — 만든 뒤 60분. 지나면 소켓이 4410 으로 닫힌다. 다시 보려면 새 세션을 연다.

string format: date-time
meta
필수
object
request_id
필수
string
timestamp
필수
string format: date-time
duration

서버 처리 시간(ms).

integer format: int32
예시
{
"data": {
"display_session_id": "dsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
"device_id": "res_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
"workspace_id": "wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
"mode": "view",
"protocol": "rfb"
}
}
Cache-Control
필수
string
허용 값: no-store

요청 형식이 틀렸다 — VALIDATION_ERROR(details.errors[]) 또는 BAD_REQUEST. 본문은 오류 봉투.

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

형식은 맞지만 할 수 없다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.