APIキー
APIキーは、Zilliz CloudコントロールプレーンおよびデータプレーンリソースにアクセスするためのAPIまたはSDK呼び出しを行うユーザーまたはアプリケーションを認証するために使用されます。APIキーは、名前やIDなどの独自のプロパティを持つ英数字の文字列です。
APIキーの概要
Zilliz Cloudは、多様なユーザー要件に対応するために2種類のAPIキーを提供します：
-
パーソナルAPIキー：ユーザー登録時に自動生成され、各キーはユーザーのアカウントにリンクし、ユーザーが所属する組織およびプロジェクト内のユーザーのロールの権限を継承します。アカウントユーザーが組織を離れる場合、関連するパーソナルキーは自動的に削除されます。組織オーナーまたはプロジェクト管理者として、Zilliz Cloudウェブコンソールで2種類のパーソナルAPIキーを確認できます：
-
自分のパーソナルAPIキー：自分専用のパーソナルキー。このAPIキーを表示およびコピーできます。
-
メンバーのパーソナルAPIキー：組織またはプロジェクト内の他のユーザーに属する既存のパーソナルキーのリスト。これらのキーの名前とIDのみを表示できますが、キー自体は表示できません。
-
-
カスタマイズAPIキー：Zilliz Cloudアカウントを持たないアプリケーションまたは外部ユーザーのために、組織オーナーおよびプロジェクト管理者が手動で作成します。これらのキーは、APIキーの作成者が組織を離れてもサービスの継続性を確保する長期的なアクセスニーズに最適です。
以下の図は、APIキーのロールとリソースアクセスを示しています。
以下の表は、割り当てられたロールに基づくAPIキーのアクセス範囲の詳細を示します。ロールと権限の詳細については、アクセス制御を参照してください。
APIキーのロール | アクセスレベル | |
|---|---|---|
組織オーナー | プロジェクトおよびクラスターを含む、組織内のすべてのリソースへの完全管理者アクセス。 | |
組織請求管理者 | 組織請求への管理者アクセスのみ。組織内のプロジェクトおよびクラスターへのアクセスはありません。 | |
組織メンバー | プロジェクト管理者 | 指定されたプロジェクトへの完全管理者アクセス、およびプロジェクト内のすべてのクラスターへの完全管理者アクセスがデフォルトで付与されます。 |
プロジェクト読込・書込 | 指定されたプロジェクトへの読み書きアクセス、およびプロジェクト内のすべてのクラスターへの読み書きアクセスがデフォルトで付与されます。 | |
プロジェクト読取専用 | 指定されたプロジェクトへの読み取り専用アクセス、およびプロジェクト内のすべてのクラスターへの読み取り専用アクセスがデフォルトで付与されます。 | |
制限と制約
-
各組織は最大100個のカスタマイズAPIキーを保持できます。
-
APIキーの管理権限は、ユーザーの組織およびプロジェクト内のロールに影響されます。特定の権限は以下のように概要されます：
組織オーナー
組織請求管理者
組織メンバー
プロジェクト管理者
プロジェクト読込・書込
プロジェクト読取専用
自分のパーソナルAPIキー
作成
自動生成
自動生成
自動生成
自動生成
自動生成
表示およびコピー
✔️
✔️
✔️
✔️
✔️
編集
✘
✘
✘
✘
✘
リセット
✔️
✔️
✔️
✔️
✔️
削除
ユーザーが組織を離れる際に自動削除
ユーザーが組織を離れる際に自動削除
ユーザーが組織を離れる際に自動削除
ユーザーが組織を離れる際に自動削除
ユーザーが組織を離れる際に自動削除
メンバーのパーソナルAPIキー
作成
自動生成
自動生成
自動生成
自動生成
自動生成
名前とIDを表示
✔️
✘
✔️
✘
✘
コピー
✘
✘
✘
✘
✘
編集
✘
✘
✘
✘
✘
リセット
✘
✘
✘
✘
✘
削除
メンバーが組織を離れる際に自動削除
メンバーが組織を離れる際に自動削除
メンバーが組織を離れる際に自動削除
メンバーが組織を離れる際に自動削除
メンバーが組織を離れる際に自動削除
カスタマイズAPIキー
作成
✔️
✘
✔️
✘
✘
表示およびコピー
✔️
✘
✔️
✘
✘
編集
✔️
✘
✔️
✘
✘
リセット
✔️
✘
✔️
✘
✘
削除
✔️
✘
✔️
✘
✘
APIキーの作成
組織ユーザーごとにZilliz Cloudが自動生成するパーソナルキーに加えて、カスタマイズキーを作成できます。組織オーナーおよびプロジェクト管理者のみがカスタマイズAPIキーを作成できます。
-
組織のAPIキーページに移動します。+ APIキーをクリックします。
-
APIキー名を入力し、APIキーのアクセスを構成します。
-
APIキー名：名前は64文字を超えてはいけません。
-
APIキーのアクセス：適切な組織およびプロジェクトロールを割り当てることで、現在のカスタマイズAPIキーのアクセス範囲を定義します。よりきめ細かなアクセス制御のために、特定のクラスターへのアクセスを制限をチェックしてキーがアクセスできるクラスターを制限できます。
📘注意プロジェクト管理者の場合、このユーザーがAPIキーに付与できる権限は、ユーザー自身の権限範囲に限定されます。
-
APIキーの表示
組織のAPIキーページに移動します。表示は特定のロールによって異なる場合があります。
-
組織オーナーとして、自分のパーソナルキー、すべてのメンバーのパーソナルキー、およびすべてのカスタマイズキーを表示できます。
-
プロジェクト管理者として、自分のパーソナルキー、権限範囲内のメンバーのパーソナルキーおよびカスタマイズキーを表示できます。たとえば、ユーザー1がプロジェクトAのプロジェクト管理者のみである場合、プロジェクトA、B、Cへの管理者アクセスを持つキー1は、ユーザー1のアクセス範囲を超えるためユーザー1には表示されません。
-
組織請求管理者、プロジェクト読込・書込、またはプロジェクト読取専用として、自分のパーソナルAPIキーのみ表示できます。
以下のスクリーンショットは、組織オーナーのAPIキー表示を示しています。
APIキーの編集
現在、カスタマイズAPIキーのみを編集できます。パーソナルキーはアカウントユーザーに紐付けられているため編集できません。パーソナルキーのアクセス範囲を変更するには、まずユーザーの組織およびプロジェクトロールを調整する必要があります。ユーザーのロールに加えられた変更は、自動的にキーのアクセス権限に反映されます。
以下の手順は、カスタマイズAPIキーの編集方法を説明しています。
-
組織のAPIキーページに移動します。アクション列の**...**をクリックし、編集をクリックします。
-
APIキーのAPIキー名およびAPIキーのアクセスを編集します。
-
APIキー名：名前は64文字を超えてはいけません。
-
APIキーのアクセス：適切な組織およびプロジェクトロールを割り当てることで、現在のカスタマイズAPIキーのアクセス範囲を定義します。よりきめ細かなアクセス制御のために、特定のクラスターへのアクセスを制限をチェックしてキーがアクセスできるクラスターを制限できます。
📘注意プロジェクト管理者の場合、このユーザーがAPIキーに付与できる権限は、ユーザー自身の権限範囲に限定されます。
-
APIキーのリセット
パーソナルまたはカスタマイズAPIキーが漏洩したと考えられる場合は、すぐにリセットする必要があります。
この操作は現在のAPIキーをリセットして無効にします。このキーを使用しているアプリケーションコードは、関連するコードを新しいキー値で更新するまで機能を停止します。
キーの種類に応じて、手順は異なります：
-
パーソナルAPIキーのリセット：ロールに関係なく、自分のパーソナルAPIキーのみリセットできます。
-
カスタマイズAPIキーのリセット：組織オーナーおよびプロジェクト管理者のみがカスタマイズAPIキーをリセットできます。
APIキーの削除
カスタマイズAPIキーが使用されなくなった場合は、できるだけ早く削除する必要があります。組織オーナーおよびプロジェクト管理者のみがカスタマイズAPIキーを削除できます。
パーソナルキーは手動で削除できませんが、対応するユーザーが組織を離れると自動的に無効化されて削除されます。
以下のスクリーンショットは、カスタマイズAPIキーの削除方法を示しています。
APIキーを削除すると、そのキーを使用するサービスによるZilliz Cloudリソースへのアクセスが不可逆的に終了します。
