コンテンツにスキップ

APIキー

Ultralytics APIキーは、リモートトレーニング、推論、自動化のための安全なプログラムによるアクセスを可能にします。異なるユースケース向けに、AES-256-GCM暗号化を使用した名前付きキーを作成できます。

Ultralytics プロファイルタブ APIキーセクション（キー一覧付き）

APIキーを作成

新しいAPIキーを作成する：

  1. 設定 > プロフィールに移動
  2. APIキーのセクションまでスクロールしてください
  3. キーを作成をクリックします。
  4. キーの名前を入力してください（例：「トレーニングサーバー」）
  5. キーを作成をクリックします。

Ultralytics プロファイルタブAPIキー作成ダイアログ

キー名

キーに分かりやすい名前を付けてください:

  • training-server - リモートトレーニングマシン用
  • ci-pipeline - CI/CD統合用
  • local-dev - ローカル開発用

キー表示

作成後、キーは一度だけ表示されます:

Ultralytics プロファイルタブAPIキー作成コピーダイアログ

キーをコピー

作成後、参照しやすいようにキーをコピーしてください。キーはキーリストでも確認できます。プラットフォームがキーを復号化し完全なキー値を表示するため、いつでもコピー可能です。

キー形式

APIキーは以下の形式に従います:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4
  • プレフィックス: ul_ Ultralyticsのキーを識別します
  • ボディ: 40個のランダムな16進数文字
  • 合計: 43文字

キーセキュリティ

  • 鍵はAES-256-GCM暗号化で保存されます
  • 認証では、高速なプレフィックス検索とハッシュ比較のためにSHA-256ハッシュを使用します
  • 完全なキー値は平文で保存されることは決してない

APIキーの使用

環境変数

キーを環境変数として設定する：

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

YOLO CLIを使用してキーを設定します:

yolo settings api_key="ul_your_key_here"

コード内

pythonスクリプトでキーを使用する：

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "ul_your_key_here"

HTTPヘッダー

APIリクエストにキーを含める：

curl -H "Authorization: Bearer ul_your_key_here" \
  https://platform.ultralytics.com/api/...

利用可能なすべてのエンドポイントについては、REST API を参照してください。

リモートトレーニング

キーを使用してメトリクスストリーミングを有効にする。

パッケージバージョンの要件

Platformのultralytics>=8.4.14が必要です。それより低いバージョンはPlatformでは動作しません。

pip install "ultralytics>=8.4.14"

export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

完全なリモートトレーニングガイドについては、クラウドトレーニングをご覧ください。

キーの管理

キーの表示

すべてのキーは以下にリストされています Settings > Profile APIキーセクションの下:

各キーカードには、キー名、完全な復号済みキー値（コピー可能）、相対的な作成時刻、および失効ボタンが表示されます。

キーの取り消し

侵害された、または不要になったキーを失効させる：

  1. APIキーセクションでキーを見つけてください
  2. 取り消し（ごみ箱）ボタンをクリックしてください
  3. 失効を確認する

即時適用

失効は即座に適用されます。そのキーを使用しているすべてのアプリケーションは動作を停止します。

キーの再生成

キーが侵害された場合：

  1. 同じ名前で新しいキーを作成する
  2. アプリケーションを更新する
  3. 古いキーを失効させる

ワークスペース API キー

APIキーは現在アクティブなワークスペースにスコープされます：

  • 個人用ワークスペース: キーは個人アカウントとして認証されます
  • チームワークスペース: キーはチームコンテキスト内で認証されます

サイドバーでワークスペースを切り替えると、APIキーセクションにはそのワークスペースのキーが表示されます。ワークスペースのAPIキーを管理するには、エディター以上のロールが必要です。ロールの詳細については「チーム」を参照してください。

セキュリティのベストプラクティス

実行すべきこと

  • キーを環境変数に保存する
  • 異なる環境には個別のキーを使用する
  • 未使用のキーは速やかに失効させる
  • キーを定期的にローテーションする
  • 主要な目的を識別するために説明的な名前を使用する

避けるべきこと

  • キーをバージョン管理にコミットする
  • アプリケーション間でキーを共有する
  • アプリケーション出力にキーをログ記録する
  • クライアントサイドのコードにキーを埋め込む

キーローテーション

セキュリティのためにキーを定期的にローテーションする:

  1. 同じ名前で新しいキーを作成する
  2. 新しいキーを使用するようにアプリケーションを更新する
  3. アプリケーションが正しく動作することを確認する
  4. 古いキーを失効させる

ローテーションスケジュール

機密性の高いアプリケーションでは、90日ごとにキーをローテーションすることを検討してください。

トラブルシューティング

無効なキーエラー

Error: Invalid API key

解決策:

  1. キーが正しくコピーされていることを確認してください（以下を含む） ul_ 接頭辞)
  2. キーが失効していないか確認する
  3. 環境変数が設定されていることを確認する
  4. 使用していることを確認してください ultralytics>=8.4.14

アクセス拒否

Error: Permission denied for this operation

解決策:

  1. リソースの所有者であるか、適切なワークスペースへのアクセス権限を持っていることを確認してください
  2. キーが正しいワークスペースに属していることを確認してください
  3. 必要に応じて新しいキーを作成してください

レート制限

Error: Rate limit exceeded

解決策:

  1. リクエスト頻度を減らす — エンドポイントごとの制限についてはレート制限表を参照
  2. 指数バックオフを実装する Retry-After ヘッダー
  3. 無制限の推論スループットを実現する専用エンドポイントを使用する

よくある質問

作成できるキーの数に制限はありますか？

APIキーに厳密な制限はありません。異なるアプリケーションや環境に合わせて必要なだけ作成できます。

キーには有効期限がありますか？

キーは自動的に期限切れになりません。失効されるまで有効です。セキュリティのためにローテーションの実装を検討してください。

キーは作成後に確認できますか？

はい、完全なキー値はキーリスト上で確認できます Settings > Profileプラットフォームは鍵を復号化して表示するため、いつでもコピーできます。

キーはリージョン固有ですか？

キーは複数のリージョンで機能しますが、アクセスできるデータはアカウントのリージョン内のデータのみです。

チームメンバーとキーを共有できますか？

より良い方法：各チームメンバーが独自のキーを作成するようにします。チームワークスペースでは、編集者以上の権限を持つメンバーが、そのワークスペースにスコープされたキーを作成できます。



📅 1ヶ月前に作成 ✏️ 5日前に更新
glenn-jochersergiuwaxmannLaughing-q

コメント