API 레퍼런스
로그인
본문으로 건너뛰기

준비 시간

GET/v1/usage/prepare

날짜별 VM 준비, 소스 내려받기, 정리 시간의 평균과 p95를 돌려줍니다

API 키 권한 read 또는 콘솔 세션으로 부릅니다, 콘솔 세션은 조직 역할 owner, admin, developer만 됩니다

  • 범위 규칙은 사용량 조회와 같습니다, from과 to가 없으면 최근 7일입니다

Headers

  • Authorization: optional string
    Bearer xci_live_… 워크스페이스 API 키, 키 권한 read(run 키도 가능), 콘솔 세션 쿠키로 대신할 수 있습니다

Query Parameters

  • org_id: optional string
    콘솔 세션은 필수, API 키는 무시(키의 조직)
  • from: optional string
    UTC 날짜, 포함
  • to: optional string
    UTC 날짜, 포함
  • workspace_id: optional string
    콘솔 세션은 워크스페이스가 필요한 곳에서 필수, API 키는 생략하거나 키의 워크스페이스와 같아야 합니다

Returns

200 application/json

  • PrepareReport: object
    • from: string
      시작 날짜(UTC)
    • to: string
      끝 날짜(UTC)
    • days: array of PrepareDay { date, jobs, vm_prepare, … }
      날짜별
      • date: string
        날짜(UTC)
      • jobs: integer
        그날 확보한 VM 슬롯 수
      • vm_prepare: PhaseStat { samples, avg_seconds, p95_seconds }
        슬롯 확보부터 VM 준비 완료까지(과금 전)
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
      • source_download: PhaseStat { samples, avg_seconds, p95_seconds }
        맥 호스트가 업로드 소스를 받아 간 시간
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
      • cleanup: PhaseStat { samples, avg_seconds, p95_seconds }
        잡 종료부터 VM 삭제 확인까지
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
    • summary: object { vm_prepare, source_download, cleanup }
      요약
      • vm_prepare: PhaseStat { samples, avg_seconds, p95_seconds }
        VM 준비
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
      • source_download: PhaseStat { samples, avg_seconds, p95_seconds }
        소스 내려받기
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
      • cleanup: PhaseStat { samples, avg_seconds, p95_seconds }
        정리
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • api_key_required: HTTP 401
    API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
  • api_key_revoked_leaked: HTTP 401
    공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
  • invalid_api_key: HTTP 401
    모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • ip_not_allowed: HTTP 403
    요청 IP가 조직 또는 API 키의 IP 허용 목록 밖입니다, details.ip와 details.list(organization 또는 api_key)에 있습니다
  • organization_suspended: HTTP 403
    운영자가 조직을 정지했습니다, 키는 거부되고 실행 중인 잡은 멈춥니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

다음 단계