APIキー
APIキー：推論APIのリクエストを、プロジェクトと利用設定へ紐付ける認証情報です。 プロジェクトごとのAPIキー画面では、キーの発行、検索、設定変更、再生成、削除ができます。
発行する
「APIキーを発行する」から、名前と次の項目を設定します。
- 有効期限
- ルール
- 予算、RPM、TPM
- ガードレール
ルールを割り当てた場合、そのルールが持つ項目はAPIキー側で設定できません。 ルールに含まれていない項目だけをキーごとに設定できます。
APIキーの平文は、発行時または再生成時に一度だけ表示されます。 すぐにパスワードマネージャーなどの安全な場所へ保存してください。
有効期限
1日、7日、30日、90日、180日、365日から選ぶか、カスタムで日付を指定します。 既定は30日です。 カスタムでは翌日以降の日付を選べ、最長で3650日先まで指定できます。 マネジメントトークンと違い、APIキーに無期限はありません。
一覧には有効期限に応じて次の状態が表示されます。
| 状態 | 意味 |
|---|---|
| 有効 | 使用できる |
| 期限間近 | 有効期限まで7日以内 |
| 期限切れ | 有効期限を過ぎた。認証には使えない |
| 無効 | 無効にしたキー |
操作
各キーの操作メニューから次の操作を選べます。
- 設定を編集する: 有効期限、ルール、予算、RPM、TPM、ガードレールを変更する
- 無効にする、有効にする: 認証を止める、再開する
- 再生成する: 新しい平文を発行する
- 削除する: キーを削除する
キーは名前で検索できます。 複数のキーを選択してまとめて削除することもできます。
再生成すると以前の値はすぐに利用できなくなります。 利用中のアプリケーションのシークレットを速やかに差し替えてください。 不要になったキーは削除してください。
停止せずに差し替える
利用中のアプリケーションを止めずに差し替える場合は、既存キーを再生成せず、次の順序で進めます。
- 同じプロジェクトに、必要なルールと利用制限を設定した新しいAPIキーを発行する
- アプリケーションのシークレットを新しい値へ差し替える
GET /v1/modelsまたは推論リクエストで疎通を確認する- 古いAPIキーを無効にする
- 古いキーを使う処理が残っていないことを確認してから削除する
Shell
curl "$AI_GATEWAY_BASE_URL/v1/models" \
-H "Authorization: Bearer $AI_GATEWAY_API_KEY"キーごとの使用状況を確認すると、古いキーからのリクエストが残っていないか判断できます。
APIキーは推論用です。 ダッシュボードの管理操作に使うマネジメントトークンとは用途が異なります。