콘텐츠로 이동
endue OSDocs

OS 설정 바꾸기

PATCH
/api/v1/stations/{station_id}/os
curl --request PATCH \
  --url https://dev.api.endueos.com/api/v1/stations/stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC/os \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "settings": { "max_virtual_devices": 5, "allowed_kinds": [ "linux", "chrome" ] } }'

가이드 — Station 과 OS

인증

섹션 제목: “인증”

파라미터

섹션 제목: “파라미터”

경로 파라미터

섹션 제목: “경로 파라미터”
station_id
필수
string
/^stn_[0-9A-HJKMNP-TV-Z]{26}$/
예시
stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC

요청 본문필수

섹션 제목: “요청 본문필수”
Media typeapplication/json
object
settings
필수

준 키만 바꾼다.

object
max_resources
integer format: int32
>= 1 <= 500
default_command_timeout_ms
integer format: int32
>= 1000 <= 120000
allowed_kinds
Array<string>
>= 1 items
허용 값: chrome mac android linux windows
max_virtual_devices

지금 있는 virtual Device 수보다 작게 줄이면 새로 만드는 것만 막힌다 (있는 것은 그대로).

integer format: int32
<= 50
max_volume_gb
integer format: int32
<= 2000
예시
{
  "settings": {
    "max_virtual_devices": 5,
    "allowed_kinds": [
      "linux",
      "chrome"
    ]
  }
}

응답

섹션 제목: “응답”

200

섹션 제목: “200”

성공.

Media typeapplication/json
object
data
필수

Station 에 정확히 하나 딸린 OS. 따로 만들거나 지울 수 없다.

object
os_id
필수
string
/^osi_[0-9A-HJKMNP-TV-Z]{26}$/
station_id
필수
string
/^stn_[0-9A-HJKMNP-TV-Z]{26}$/
version
필수

이 OS 를 만든 endue OS 릴리스.

string
status
필수
string
허용 값: running halted
settings
필수
object
max_resources
필수

Station 에 등록할 수 있는 Device 수 (actual·virtual 합계). 1~500, 기본 50.

integer format: int32
>= 1 <= 500
default_command_timeout_ms
필수

명령에 timeout_ms 가 없을 때 쓰는 값. 1000~120000, 기본 12000.

integer format: int32
>= 1000 <= 120000
allowed_kinds
필수

허용하는 Device 종류. 기본은 다섯 가지 전부. actual·virtual 모두에 적용된다.

Array<string>
허용 값: chrome mac android linux windows
max_virtual_devices
필수

Station 에 만들 수 있는 virtual Device 수. 0~50, 기본 10. 0 이면 virtual Device 를 만들 수 없다.

integer format: int32
<= 50
max_volume_gb
필수

Station 의 virtual Device 영구 볼륨(Storage) 크기 합계 상한 (GB). 0~2000, 기본 100.

integer format: int32
<= 2000
booted_at
필수
Any of:
string format: date-time
halted_at
필수
Any of:
string format: date-time
created_at
필수
string format: date-time
updated_at
필수
string format: date-time
meta
필수
object
request_id
필수
string
timestamp
필수
string format: date-time
duration

서버 처리 시간(ms).

integer format: int32
예시
{
  "data": {
    "os_id": "osi_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "station_id": "stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "status": "running",
    "settings": {
      "allowed_kinds": [
        "chrome"
      ]
    }
  }
}

400

섹션 제목: “400”

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

401

섹션 제목: “401”

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

403

섹션 제목: “403”

이 인증 수단으로는 못 하는 일이다 — FORBIDDEN (예: API 키로 클라우드 기기 만들기). 본문은 오류 봉투.

404

섹션 제목: “404”

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

429

섹션 제목: “429”

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

500

섹션 제목: “500”

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

503

섹션 제목: “503”

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