ClickHouse Cloud API は、開発者が ClickHouse Cloud 上の
組織やサービスを簡単に管理できるように設計された REST API です。Cloud API を使用すると、
サービスの作成と管理、API キーの発行、
組織内メンバーの追加や削除などを行えます。
最初の API キーを作成して ClickHouse Cloud API の利用を開始する方法をご覧ください。
Swagger (OpenAPI) エンドポイントと UI
お使いの組織が 新しい料金プラン のいずれかに移行されており、OpenAPI を使用している場合は、サービス作成の POST リクエストから tier フィールドを削除する必要があります。サービス tiers は廃止されたため、サービスオブジェクトから tier フィールドは削除されました。
この変更は、POST、GET、および PATCH の各サービスリクエストで返されるオブジェクトに影響します。そのため、これらの API を利用するコードは、この変更に対応できるよう調整が必要になる場合があります。 組織が新しい料金プランのいずれかに移行されている場合は、ClickHouse Terraform プロバイダー バージョン 2.0.0 以降を使用する必要があります。このアップグレードは、料金プランの移行後にサービスの tier 属性が変更され、tier フィールドが受け付けられなくなるため必要です。tier への参照は削除してください。また、サービスリソースのプロパティとして num_replicas フィールドも指定できるようになります。
- plan および apply の実行時に、
Beta Resource 警告として表示されます。Terraform は警告によって失敗しないため、実行は通常どおり続行されます。
- ドキュメント内では、「This resource is in beta」と記載されたコールアウトで示されます。
ベータであることは、将来の provider バージョンでスキーマや動作が変更される可能性があることを意味します。マーカーのないものはすべて GA であり、通常の互換性保証の対象です。
v3.25.2 より前では、provider はこれらのリソースを ベータ ではなく alpha としてマークしており、plan 実行時の警告は Alpha Resource でした。変更されたのは表現のみであり、スキーマ、動作、状態移行は関係しません。ただし、plan 出力から Alpha Resource を grep するツールは、警告なく一致しなくなります。以前のリリースでは、別個の alpha ビルドも公開されていました。
-alphaN 接尾辞が付いたバージョン (例: 3.15.0-alpha3) は、単一ビルドモデルの導入以前のものです。引き続き利用できますが、新たに作成されることはありません。
機能が一般提供に達すると、次回のproviderリリースで該当リソースからベータマーカーが外れます。plan 実行時の警告は表示されなくなり、ドキュメントのコールアウトも削除されます。それ以外に変更はありません。configurationの編集、状態移行、ビルド間の切り替えは不要です。
各サービスの作成時に設定されるデフォルトのレプリカ数は、Scale tier と Enterprise tier では 3、Basic tier では 1 です。
Scale tier と Enterprise tier では、サービス作成リクエストで numReplicas フィールドを指定することで、この数を調整できます。
ウェアハウス内の最初のサービスでは、numReplicas フィールドの値は 2 ～ 20 である必要があります。既存のウェアハウス内に作成するサービスでは、レプリカ数を 1 まで下げることができます。
迅速にサポートを受けるには、まず Slack チャンネル をご確認いただくことをおすすめします。API とその機能について、さらにサポートが必要な場合や詳しい情報をご希望の場合は、https://console.clickhouse.cloud/support から ClickHouse Support までお問い合わせください 
