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