본문으로 건너뛰기

비용 조회

GET/v1/cost

기간의 비용 합계와 일별 막대, 워크스페이스나 API 키나 러너별 묶음을 돌려줍니다

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

  • 사용량 조회와 같은 원장 행을 씁니다, 범위 규칙도 같습니다
  • group_by는 day, workspace, api_key, runner를 쉼표로 이어 여러 개 줄 수 있고 day는 항상 daily로 돌려줍니다

Headers

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

Query Parameters

  • org_id: optional string
    콘솔 세션은 필수, API 키는 무시(키의 조직)
  • range: optional "mtd" or "last_month" or "7d" or "30d" or "custom"
    mtd는 이번 달 1일부터 오늘, last_month는 지난 달력 월, 7d와 30d는 오늘 포함 최근 7일과 30일, custom은 from과 to(둘 다 필수, 최대 366일), 모두 UTC
    기본값 "mtd"
  • from: optional string
    UTC 날짜, 포함
  • to: optional string
    UTC 날짜, 포함
  • group_by: optional string
    day, workspace, api_key, runner를 쉼표로 이어서, day는 항상 daily로 돌아옵니다
    기본값 "day"
  • workspace_id: optional string
    콘솔 세션은 워크스페이스가 필요한 곳에서 필수, API 키는 생략하거나 키의 워크스페이스와 같아야 합니다
  • api_key_id: optional string
    이 키의 잡만

Returns

200 application/json

  • CostReport: object
    • organization_id: string
      조직 ID
    • range: "mtd" or "last_month" or "7d" or "30d" or "custom"
      기간 종류
    • from: string
      시작 날짜(UTC)
    • to: string
      끝 날짜(UTC)
    • group_by: array of "day" or "workspace" or "api_key" or "runner"
      묶음 기준
    • total: UsageRow { key, label, jobs, … }
      기간 합계
      • key: string
        group_by에 따라 UTC 날짜(YYYY-MM-DD), workspace_id 또는 api_key_id
      • label: optional string or null
        사람이 읽는 이름
      • jobs: integer
        잡 수
      • billed_minutes: integer
        과금 분 합
      • amount_micro_usd: integer
        금액 합(µUSD)
        최소 0
      • amount_usd: string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
    • daily: array of UsageRow { key, label, jobs, … }
      날짜별 금액, 0인 날 포함
      • key: string
        group_by에 따라 UTC 날짜(YYYY-MM-DD), workspace_id 또는 api_key_id
      • label: optional string or null
        사람이 읽는 이름
      • jobs: integer
        잡 수
      • billed_minutes: integer
        과금 분 합
      • amount_micro_usd: integer
        금액 합(µUSD)
        최소 0
      • amount_usd: string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
    • groups: object { workspace, api_key, runner }
      요청한 group_by별 묶음
      • workspace: optional array of UsageRow { key, label, jobs, … }
        워크스페이스
        • key: string
          group_by에 따라 UTC 날짜(YYYY-MM-DD), workspace_id 또는 api_key_id
        • label: optional string or null
          사람이 읽는 이름
        • jobs: integer
          잡 수
        • billed_minutes: integer
          과금 분 합
        • amount_micro_usd: integer
          금액 합(µUSD)
          최소 0
        • amount_usd: string
          같은 금액의 USD 문자열(센트, 소수 2자리)
          형식 ^-?[0-9]+\.[0-9]{2}$
      • api_key: optional array of UsageRow { key, label, jobs, … }
        키 없이 실행한 콘솔과 플레이그라운드 잡은 키 none으로 묶입니다
        • key: string
          group_by에 따라 UTC 날짜(YYYY-MM-DD), workspace_id 또는 api_key_id
        • label: optional string or null
          사람이 읽는 이름
        • jobs: integer
          잡 수
        • billed_minutes: integer
          과금 분 합
        • amount_micro_usd: integer
          금액 합(µUSD)
          최소 0
        • amount_usd: string
          같은 금액의 USD 문자열(센트, 소수 2자리)
          형식 ^-?[0-9]+\.[0-9]{2}$
      • runner: optional array of UsageRow { key, label, jobs, … }
        키는 러너 ID macos-m4:xcode-<버전>, 잡이 고른 Xcode로 나눕니다
        • key: string
          group_by에 따라 UTC 날짜(YYYY-MM-DD), workspace_id 또는 api_key_id
        • label: optional string or null
          사람이 읽는 이름
        • jobs: integer
          잡 수
        • billed_minutes: integer
          과금 분 합
        • amount_micro_usd: integer
          금액 합(µUSD)
          최소 0
        • amount_usd: string
          같은 금액의 USD 문자열(센트, 소수 2자리)
          형식 ^-?[0-9]+\.[0-9]{2}$
    • csv_url: string
      같은 조건의 CSV 상대 URL

오류

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

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

다음 단계