APIキー
APIキーは、Zilliz CloudコントロールプレーンおよびデータプレーンリソースにアクセスするためのAPIまたはSDK呼び出しを行うユーザーまたはアプリケーションを認証するために使用されます。APIキーは、名前とIDなどの独自のプロパティを持つ英数字の文字列です。
APIキーの概要
Zilliz Cloudは、さまざまなユーザーの要求に応えるために2種類のAPIキーを提供します：
-
個人用APIキー： ユーザー登録時に自動的に生成され、各キーはユーザーのアカウントにリンクされ、ユーザーが所属する組織とプロジェクト内のユーザーのロールの権限を継承します。アカウントユーザーが組織を離れると、 associated personal keyは自動的に削除されます。組織オーナーまたはプロジェクト管理者として、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のプロジェクト管理者のみで、キー1がプロジェクトA、B、およびCへの管理者アクセスを持っている場合、キー1のアクセススコープはユーザー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リソースへのアクセスが不可逆的に終了します。
