화면 한 장 (옛 경로)

GET

/api/v1/resources/{resource_id}/screen

const url = 'https://dev.api.endueos.com/api/v1/resources/res_01J9ZK3Q8M4XW7D2N5R6T0V1BC/screen';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev.api.endueos.com/api/v1/resources/res_01J9ZK3Q8M4XW7D2N5R6T0V1BC/screen \
  --header 'Authorization: Bearer <token>'

리소스의 화면 한 장 (에이전트의 screenshot). max_age_ms 안에 찍은 것이 있으면 그것을 준다 — 여러 화면이 같은 기기를 보아도 기기에는 한 번만 묻는다. 화면 동기화는 이 경로를 주기적으로 부르는 것이다 (v0.2.0 에는 영상 스트림이 없다). 리소스당 초당 2장까지. v0.2.0 은 chrome·android 만. 다른 kind 는 422 SCREEN_UNSUPPORTED.

가이드 — 화면

인증

파라미터

경로 파라미터

resource_id

필수

string

/^res_[0-9A-HJKMNP-TV-Z]{26}$/

예시

res_01J9ZK3Q8M4XW7D2N5R6T0V1BC

쿼리 파라미터

max_age_ms

integer format: int32

>= 500 <= 60000

이만큼 오래된 화면까지는 다시 찍지 않는다. 500~60000, 기본 1000.

응답

200

성공.

응답 헤더

X-Frame-At

필수

string

찍은 시각 (RFC 3339).

Cache-Control

필수

string

허용 값: no-store

400

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

401

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

404

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

409

지금 상태와 충돌한다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

422

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

429

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

500

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

503

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

504

결과를 알 수 없다 — COMMAND_OUTCOME_UNKNOWN, 같은 request_id 로 다시. 본문은 오류 봉투.