Получить данные о затратах организации на использование

Возвращает общую сумму и список ежедневных записей о стоимости использования организации по каждой сущности за указанный период (максимум 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: https://clickhouse.com/docs/cloud/manage/openapi

Параметры пути

organizationId · string<uuid> · обязательно

Идентификатор запрошенной организации.

Параметры запроса

from_date · string<date-time> · обязательно

Дата начала отчёта, например 2024-12-19.

to_date · string<date-time> · обязательно

Дата окончания отчёта (включительно), например 2024-12-20. Эта дата не может быть более чем на 30 дней позже from_date (то есть максимальный запрашиваемый период составляет 31 день).

Ответ

200

application/json

Успешный ответ

requestId · string<uuid>

Уникальный идентификатор, присваиваемый каждому запросу. UUIDv4

result · object

Show child attributes

status · number

Код состояния HTTP.

Пример:

200