メインコンテンツまでスキップ
メインコンテンツまでスキップ

ClickHouse Cloud API

概要​

ClickHouse Cloud APIは、開発者がClickHouse Cloud上で組織やサービスを簡単に管理できるように設計されたREST APIです。このCloud APIを使用することで、サービスの作成と管理、APIキーのプロビジョニング、組織内のメンバーの追加および削除などを行うことができます。

最初のAPIキーを作成してClickHouse Cloud APIを使用する方法を学びましょう。

Swagger (OpenAPI) エンドポイントとUI​

ClickHouse Cloud APIは、予測可能なクライアント側での消費を可能にするために、オープンソースのOpenAPI仕様に基づいて構築されています。ClickHouse Cloud APIドキュメントをプログラムで消費する必要がある場合は、https://api.clickhouse.cloud/v1 経由でJSONベースのSwaggerエンドポイントを提供しています。また、Swagger UIを通じてAPIドキュメントも確認できます。

注記

あなたの組織が新しい料金プランに移行している場合、OpenAPIを使用する際には、サービス作成のPOSTリクエストからtierフィールドを削除する必要があります。

tierフィールドはもはやサービスの階層がないため、サービスオブジェクトから削除されました。
これは、POST、GET、およびPATCHサービスリクエストによって返されるオブジェクトに影響します。したがって、これらのAPIを消費するコードは、これらの変更に対応するように調整が必要となる場合があります。

レート制限​

開発者は1組織あたり100のAPIキーに制限されています。各APIキーは、10秒間で10回のリクエスト制限があります。組織のAPIキーや10秒間のリクエスト数を増やしたい場合は、[email protected]までお問い合わせください。

Terraformプロバイダー​

公式のClickHouse Terraformプロバイダーを使用すると、Infrastructure as Code を利用して、予測可能でバージョン管理された設定を作成し、デプロイメントをよりエラーが少ないものにすることができます。

Terraformプロバイダーのドキュメントは、Terraformレジストリで確認できます。

ClickHouse Terraformプロバイダーに貢献したい場合は、GitHubリポジトリでソースを確認できます。

注記

あなたの組織が新しい料金プランに移行している場合、サービスのtier属性の変更を処理するために、バージョン2.0.0以上のClickHouse Terraformプロバイダーを使用する必要があります。このアップグレードは、料金移行後にtierフィールドが受け入れられず、それに対する参照を削除する必要があるためです。

また、サービスリソースのプロパティとしてnum_replicasフィールドを指定できるようになります。

TerraformとOpenAPIの新しい料金：レプリカ設定の説明​

各サービスに作成されるレプリカの数は、ScaleおよびEnterprise階層ではデフォルトで3、Basic階層ではデフォルトで1です。ScaleおよびEnterprise階層では、サービス作成リクエストにnumReplicasフィールドを渡すことで調整可能です。
numReplicasフィールドの値は、倉庫内の最初のサービスに対して2以上20以下でなければなりません。既存の倉庫内で作成されたサービスは、最低1のレプリカを持つことができます。

サポート​

迅速なサポートを受けるには、まず私たちのSlackチャンネルを訪れることをお勧めします。追加のヘルプやAPIの機能に関する情報が必要な場合は、https://console.clickhouse.cloud/support にてClickHouseサポートにお問い合わせください。