APIキー取得の全体像
Pineconeを操作するすべてのリクエスト(インデックスの作成、ベクトルの登録・検索、プロジェクト設定など)はプロジェクト単位のAPIキーによる認証が必須です。APIキーはコンソールからGUI操作で発行する方法と、Admin API経由でプログラムから発行する方法の二通りがあります。以下では手順と運用上の注意点を整理します。docs.pinecone.io
1. 事前準備
| 項目 | 内容 |
|---|---|
| Pineconeアカウント | https://app.pinecone.io にアクセスし、Google/GitHub/メールアドレスいずれかでサインアップ |
| プロジェクト | APIキーはプロジェクトごとに発行されます。まだ無い場合は「Create project」で新規作成しておく |
| 権限 | Starterプランは「All(読み書き可)」のみ。Standard/Enterpriseプランは細粒度権限(Read-only など)が選択可能 |
2. コンソールからAPIキーを生成(推奨)
-
Pineconeコンソールにログインし、左ペインで対象プロジェクトを選択
-
上部タブから “API keys” を開く
-
“Create API key” をクリック
-
ダイアログで
-
Key name(わかりやすい識別子)
-
Permissions(Starterの場合は All のみ)
を入力し Create key を押下
-
-
表示されたキーをその場でコピーし、安全な場所(パスワードマネージャ等)に保管
-
ダイアログを閉じると再表示できません
-
-
キー作成後、一覧に Created by 列が追加表示(2025-01-29 の更新)され、発行者を確認できます docs.pinecone.iodocs.pinecone.io
3. Admin APIでプログラム生成(CI/CD向け)
自動化が必要な場合は Admin API を利用して POST /admin/projects/{project_id}/api-keys で生成可能です。ヘッダーにアクセストークン(組織レベルのOAuthトークン)を付与し、JSONボディで name/permissions を指定します。docs.pinecone.io
4. キーの安全な取り扱い
| シチュエーション | 推奨策 |
|---|---|
| ローカル開発 | .env ファイルまたは OS 環境変数に保存し、コードベースにハードコードしない |
| GitHub Actions | 暗号化シークレット に登録し、ワークフロー内で $PINECONE_API_KEY として参照 |
| 共有リポジトリ | Secret Scanning で誤コミットを検出。万一漏えいした場合は直ちにキーをローテーション |
誤コミット後は Keys > … > Delete で該当キーを削除し、アプリ側の環境変数を新キーに更新します(同名キーが1件のみの場合は先に新キーを発行してから削除)。docs.gitguardian.com
5. キーのローテーションとモニタリング
-
ローテーション頻度: 機密度が高いワークロードなら 90 日〜半年ごとに再発行
-
監査ログ: Enterpriseプランではキーの利用履歴を監査ログで確認可能
-
最小権限の原則: ステージング環境は ReadWrite、本番は ReadOnly などキーを分割
-
利用統計: APIダッシュボードでリクエスト数・エラー率を観測し、異常スパイクを早期検知
6. よくあるトラブルシューティング
| 症状 | 原因と対処 |
|---|---|
| 401 Unauthorized | キーが誤っている/Environment変数が未設定/対象プロジェクトが違う |
| 403 Forbidden | Starterプランで権限不足の操作(例: 特定Admin API)を実行 |
| 429 Too Many Requests | 無料枠上限を超過。プランアップグレードまたはレートリミット緩和申請 |
| 404 Project not found | URL のプロジェクトID誤り、またはリージョン(gcp-starter-us-east-1 等)を指定し忘れ |
まとめ
-
GUI手順が最も簡単で確実。発行後は即座に保管し再表示不能に注意
-
Admin APIで自動発行すると複数環境やCIでも一貫したキー管理が可能
-
キーは環境変数で扱い、Gitなど公開範囲に含めない
-
定期ローテーションと最小権限でセキュリティを強化し、ダッシュボードで使用状況を継続監視
これでPinecone利用前のAPIキー取得と安全な運用準備が完了します。
ChatGPT4o 生成日:2025/06/20