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

배치 조회

GET/v1/batches/{batch_id}

배치의 진행률, 잡별 상태, 총 비용을 돌려줍니다

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

Headers

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

Path Parameters

  • batch_id: string
    배치 ID
    형식 ^bat_[A-Za-z0-9]+$

Returns

200 application/json

  • Batch: object
    • id: string
      ID
    • organization_id: string
      조직 ID
    • workspace_id: string
      워크스페이스 ID
    • name: optional string or null
      이름
    • recipe_id: optional string or null
      레시피 ID
    • status: "running" or "completed" or "cancelled"
      running, completed, cancelled
    • matrix: optional BatchMatrix { xcode, simulator, scheme }
      매트릭스
      • xcode: optional array of string
        Xcode 버전 축
        최대 10개
      • simulator: optional array of string
        시뮬레이터 축
        최대 20개
      • scheme: optional array of string
        스킴 축
        최대 20개
    • requested_jobs: integer
      요청한 조합 수
    • accepted_jobs: integer
      받은 잡 수
    • rejected_jobs: integer
      거절된 조합 수
    • progress: object { queued, preparing, running, … }
      상태별 잡 수
      • queued: optional integer
        대기 중
      • preparing: optional integer
        준비 중인 잡 수
      • running: optional integer
        실행 중
      • succeeded: optional integer
        성공한 잡 수
      • failed: optional integer
        실패한 잡 수
      • cancelled: optional integer
        취소된 잡 수
      • other_ended: optional integer
        credit_exhausted, platform_error, timed_out으로 끝난 수
      • done: optional integer
        끝난 잡 수
      • percent: optional integer
        done / accepted_jobs, 받은 잡이 없으면 100
        최소 0, 최대 100
    • amount_micro_usd: integer
      받은 잡의 금액 합(정산액 또는 실행 중 누적액)
      최소 0
    • amount_usd: string
      같은 금액의 USD 문자열(센트, 소수 2자리)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • created_at: optional string
      만든 시각
      RFC 3339 UTC 시각
    • cancelled_at: optional string or null
      취소 시각
    • items: array of BatchItem { index, xcode, simulator, … }
      조합별 항목
      • index: integer
        조합 순번
      • xcode: optional string or null
        Xcode 버전
      • simulator: optional string or null
        시뮬레이터
      • scheme: optional string or null
        스킴
      • job_id: string or null
        제출 때 거절된 조합이면 null
      • status: string
        rejected 또는 그 잡의 상태
      • error: optional object { code, message } or null
        거절 오류
        • code: optional string
          오류 코드
        • message: optional string
          오류 설명
      • amount_micro_usd: optional integer
        금액(µUSD 정수)
        최소 0
      • amount_usd: optional string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$

오류

  • 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와 함께 알려 주세요

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

다음 단계