获取组织使用成本

返回查询时间范围内该 organization 的总费用，以及按天、按 entity 划分的 organization 用量成本记录列表（最长 31 天）。请求和响应中的所有日期均按 UTC timezone 计算。

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