조직 사용 비용 조회

조회한 시간 범위(최대 31일) 동안 해당 organization의 일별 엔터티별 organization 사용 비용 레코드 목록과 총합계를 반환합니다. 요청과 응답의 모든 날짜는 UTC 시간대를 기준으로 계산됩니다.

GET /v1/organizations/{organizationId}/usageCost

조직 사용 비용 조회

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "costs": {
      "dataWarehouseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "2023-12-25",
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityName": "<string>",
      "locked": true,
      "metrics": {
        "backupCHC": 123,
        "computeCHC": 123,
        "dataTransferCHC": 123,
        "initialLoadCHC": 123,
        "interRegionTier1DataTransferCHC": 123,
        "interRegionTier2DataTransferCHC": 123,
        "interRegionTier3DataTransferCHC": 123,
        "interRegionTier4DataTransferCHC": 123,
        "publicDataTransferCHC": 123,
        "storageCHC": 123
      },
      "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "totalCHC": 123
    },
    "grandTotalCHC": 123
  },
  "status": 200
}

{
  "error": "<string>",
  "status": 400
}

인증

Authorization · string · header · 필수

ClickHouse Cloud 콘솔에서 발급받은 key ID와 key secret을 사용합니다: https://clickhouse.com/docs/cloud/manage/openapi

경로 매개변수

organizationId · string<uuid> · 필수

요청한 organization의 ID입니다.

쿼리 매개변수

from_date · string<date-time> · 필수

보고서의 시작 날짜입니다. 예: 2024-12-19.

to_date · string<date-time> · 필수

보고서의 종료 날짜(포함)입니다. 예: 2024-12-20. 이 날짜는 from_date로부터 30일을 초과할 수 없습니다(최대 조회 기간 31일).

응답

200

application/json

성공적인 응답

requestId · string<uuid>

모든 요청에 할당되는 고유 ID입니다. UUIDv4

result · object

Show child attributes

status · number

HTTP 상태 코드입니다.

예시:

200