データサービスの API キー
TiDB Cloud Data API は基本認証とダイジェスト認証の両方をサポートします。
- 基本認証暗号化されていない Base64 エンコードを使用して、公開キーと秘密キーを送信します。 HTTPS により通信のセキュリティが確保されます。詳細については、 RFC 7617 - 「基本」HTTP 認証スキームを参照してください。
- ダイジェスト認証ネットワーク送信前に公開キー、秘密キー、サーバー提供の nonce 値、HTTP メソッド、および要求された URI をハッシュすることにより、追加のセキュリティレイヤーを提供します。これにより、秘密キーが暗号化され、平文で送信されるのを防ぎます。詳細については、 RFC 7616 - HTTP ダイジェスト アクセス認証を参照してください。
注記：
Data Service の Data API キーは、 TiDB CloudAPIで使用されるキーとは異なります。 Data API キーはTiDB Cloudクラスター内のデータにアクセスするために使用され、 TiDB CloudAPI キーはプロジェクト、クラスター、バックアップ、復元、インポートなどのリソースを管理するために使用されます。
APIキーの概要
- API キーには公開キーと秘密キーが含まれており、認証に必要なユーザー名とパスワードとして機能します。秘密キーはキーの作成時にのみ表示されます。
- 各 API キーは 1 つのデータ アプリにのみ属し、 TiDB Cloudクラスター内のデータにアクセスするために使用されます。
- すべてのリクエストで正しい API キーを指定する必要があります。それ以外の場合、 TiDB Cloud は
401エラーで応答します。
レート制限
リクエスト クォータは次のようにレート制限されます。
- API キーあたり 1 分あたり 100 リクエスト (rpm)
- Chat2Query データ アプリごとに 1 日あたり 100 リクエスト
レート制限を超えると、API は429エラーを返します。割り当てを増やすには、サポート チームにリクエストを送信する連絡してください。
APIキーを管理する
次のセクションでは、データ アプリの API キーを作成、編集、削除する方法について説明します。
APIキーを作成する
データ アプリの API キーを作成するには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
「認証」領域で、 「API キーの作成」をクリックします。
[API キーの作成]ダイアログ ボックスで、説明を入力し、API キーのロールを選択します。
このロールは、API キーがデータ アプリにリンクされたクラスターに対してデータの読み取りまたは書き込みを行えるかどうかを制御するために使用されます。
ReadOnlyまたはReadAndWrite役割を選択できます。ReadOnly: API キーはSELECT、SHOW、USE、DESC、EXPLAINステートメントなどのデータの読み取りのみを許可します。ReadAndWrite: API キーによるデータの読み取りと書き込みを許可します。この API キーを使用して、DML ステートメントや DDL ステートメントなどのすべての SQL ステートメントを実行できます。
「次へ」をクリックします。公開鍵と秘密鍵が表示されます。
秘密キーをコピーして安全な場所に保存したことを確認してください。このページを離れると、完全な秘密キーを再度取得することはできなくなります。
「完了」をクリックします。
APIキーを編集する
API キーの説明を編集するには、次の手順を実行します。
- プロジェクトのデータサービスページに移動します。
- 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
- [API キー]領域で [**アクション]列を見つけ、変更する API キー行で[...] > [編集]**をクリックします。
- API キーの説明または役割を更新します。
- 「更新」をクリックします。
APIキーを削除する
注記：
API キーを削除する前に、その API キーがどのデータ アプリでも使用されていないことを確認してください。
データ アプリの API キーを削除するには、次の手順を実行します。
- プロジェクトのデータサービスページに移動します。
- 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
- [API キー]領域で、 [アクション]列を見つけて、削除する API キー行の[...] > [削除]をクリックします。
- 表示されるダイアログボックスで、削除を確認します。