ClickHouse/docs/ja/cloud/manage/openapi.md

sidebar_label	slug	title
APIキーの管理	/ja/cloud/manage/openapi	APIキーの管理

ClickHouse Cloudは、OpenAPIを利用したAPIを提供しており、アカウントおよびサービスの各種要素をプログラムで管理することができます。

APIキーの管理

:::note このドキュメントは、ClickHouse Cloud APIについて説明しています。データベースAPIのエンドポイントについては、Cloud Endpoints APIをご覧ください。 :::

1. 左側のメニューのAPI Keysタブを使用して、APIキーの作成と管理ができます。

2. API Keysページは、最初にAPIキーを作成するためのプロンプトを表示します。最初のキーを作成した後は、画面右上に表示される New API Key ボタンを使用して新しいキーを作成できます。

3. APIキーを作成するには、キー名、キーの権限、および有効期限を指定し、Generate API Key をクリックします。

4. 次の画面では、Key ID と Key secret が表示されます。この値をコピーして、金庫などの安全な場所に保管してください。この画面を離れた後は、これらの値は表示されません。

5. ClickHouse Cloud APIは、HTTP Basic Authenticationを使用してAPIキーの有効性を確認します。以下は、curlを使用してClickHouse Cloud APIにリクエストを送信する例です：

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

6. API Keysページに戻ると、キーの名前、Key IDの最後の4文字、権限、ステータス、満期日、および作成者が表示されます。この画面からキー名、権限、および有効期限を編集することができます。キーはこの画面から無効化または削除することもできます。

:::note APIキーを削除すると、この操作は取り消すことができません。このキーを使用しているサービスは、すぐにClickHouse Cloudへのアクセスができなくなります。 :::

エンドポイント

エンドポイントドキュメントはこちら。API Key と API Secret を利用して、ベースURL https://api.clickhouse.cloud/v1 を使用してください。