組織の利用コストを取得

照会した期間内の組織について、総額と、エンティティごとの日次組織利用コストレコードの一覧を返します（最大 31 日間）。リクエストとレスポンスの両方に含まれるすべての日付は、UTC タイムゾーンに基づいて評価されます。

GET /v1/organizations/{organizationId}/usageCost

組織の利用コストを取得

cURL

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

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
}

承認

Authorization · string · header · 必須

ClickHouse Cloud コンソールで取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

要求された組織の 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