API-Schlüssel

Die API-Schlüssel Ultralytics ermöglichen einen sicheren programmatischen Zugriff für Remote-Training, Inferenz und Automatisierung. Erstellen Sie benannte Schlüssel mit AES-256-GCM-Verschlüsselung für verschiedene Anwendungsfälle.

API-Schlüssel erstellen

Neuen API-Schlüssel erstellen:

1. Gehen Sie zu Einstellungen > Profil
2. Scrollen Sie zum Abschnitt „API-Schlüssel “.
3. Klicken Sie auf Schlüssel erstellen
4. Geben Sie einen Namen für den Schlüssel ein (z. B. „Schulungsserver“).
5. Klicken Sie auf Schlüssel erstellen

Schlüsselname

Geben Sie Ihrem Schlüssel einen aussagekräftigen Namen:

• training-server - Für Remote-Trainingsmaschinen
• ci-pipeline - Für CI/CD-Integration
• local-dev - Für die lokale Entwicklung

Schlüsselanzeige

Nach der Erstellung wird der Schlüssel einmal angezeigt:

Schlüsselformat

API-Schlüssel haben folgendes Format:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Präfix: ul_ identifiziert Ultralytics Schlüssel
• Hauptteil: 40 zufällige hexadezimale Zeichen
• Gesamt: 43 Zeichen

Schlüsselsicherheit

• Schlüssel werden mit AES-256-GCM-Verschlüsselung gespeichert.
• Die Authentifizierung verwendet SHA-256-Hash für eine schnelle Präfixsuche und einen Hash-Vergleich.
• Vollständige Schlüsselwerte werden niemals im Klartext gespeichert.

Verwendung von API-Schlüsseln

Umgebungsvariable

Legen Sie Ihren Schlüssel als Umgebungsvariable fest:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

Legen Sie den Schlüssel mithilfe derCLI fest:

yolo settings api_key="ul_your_key_here"

Im Code

Verwenden Sie den Schlüssel in Ihren Python-Skripten:

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-Header

Fügen Sie den Schlüssel in API-Anfragen ein:

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

Alle verfügbaren Endpunkte finden Sie in der REST API .

Remote-Training

Aktivieren Sie Metrik-Streaming mit Ihrem Schlüssel.

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

Die vollständige Anleitung für Fernschulungen finden Sie unter Cloud-Schulungen.

Schlüssel verwalten

Schlüssel anzeigen

Alle Tasten sind aufgelistet in Settings > Profile im Abschnitt „API-Schlüssel“:

Jede Schlüsselkarte zeigt den Schlüsselnamen, den vollständig entschlüsselten Schlüsselwert (kopierbar), die relative Erstellungszeit und eine Schaltfläche zum Widerrufen.

Schlüssel widerrufen

Widerrufen Sie einen Schlüssel, der kompromittiert ist oder nicht mehr benötigt wird:

1. Den Schlüssel finden Sie im Abschnitt „API-Schlüssel“.
2. Klicken Sie auf die Schaltfläche „Widerrufen“ (Papierkorb).
3. Widerruf bestätigen

Schlüssel neu generieren

Wenn ein Schlüssel kompromittiert wurde:

1. Erstellen Sie einen neuen Schlüssel mit dem gleichen Namen.
2. Ihre Anwendungen aktualisieren
3. Den alten Schlüssel widerrufen

API-Schlüssel für den Arbeitsbereich

API-Schlüssel gelten für den aktuell aktiven Arbeitsbereich:

• Persönlicher Arbeitsbereich: Schlüssel authentifizieren sich als Ihr persönliches Konto
• Team-Arbeitsbereich: Schlüssel werden innerhalb des Teamkontexts authentifiziert.

Wenn Sie in der Seitenleiste den Arbeitsbereich wechseln, werden im Abschnitt „API-Schlüssel“ die Schlüssel für diesen Arbeitsbereich angezeigt. Zum Verwalten von API-Schlüsseln für Arbeitsbereiche ist mindestens die Rolle „Editor“ erforderlich. Details zu den Rollen finden Sie unter „Teams “.

Bewährte Sicherheitspraktiken

Tun Sie

• Schlüssel in Umgebungsvariablen speichern
• Separate Schlüssel für verschiedene Umgebungen verwenden
• Unbenutzte Schlüssel umgehend widerrufen
• Schlüssel regelmäßig rotieren
• Verwenden Sie beschreibende Namen, um wichtige Zwecke zu kennzeichnen.

Tun Sie nicht

• Schlüssel in der Versionskontrolle ablegen
• Schlüssel zwischen Anwendungen teilen
• Schlüssel in der Anwendungsausgabe protokollieren
• Schlüssel in clientseitigem Code einbetten

Schlüsselrotation

Schlüssel aus Sicherheitsgründen regelmäßig rotieren:

1. Neuen Schlüssel mit gleichem Namen erstellen
2. Anwendungen aktualisieren, um den neuen Schlüssel zu verwenden
3. Überprüfen, ob Anwendungen korrekt funktionieren
4. Alten Schlüssel widerrufen

Fehlerbehebung

Fehler: Ungültiger Schlüssel

Error: Invalid API key

Lösungen:

1. Überprüfen Sie, ob der Schlüssel korrekt kopiert wurde (einschließlich des ul_ Präfix)
2. Prüfen, ob der Schlüssel nicht widerrufen wurde
3. Bestätigen Sie, dass die Umgebungsvariable gesetzt ist
4. Stellen Sie sicher, dass Sie ultralytics>=8.4.14

Zugriff verweigert

Error: Permission denied for this operation

Lösungen:

1. Überprüfen Sie, ob Sie der Eigentümer der Ressource sind oder über die entsprechenden Zugriffsrechte für den Arbeitsbereich verfügen.
2. Überprüfen Sie, ob der Schlüssel zum richtigen Arbeitsbereich gehört.
3. Erstellen Sie bei Bedarf einen neuen Schlüssel.

Ratenbegrenzung

Error: Rate limit exceeded

Lösungen:

1. Reduzieren Sie die Anforderungshäufigkeit – siehe die Tabelle mit den Ratenbeschränkungen für die Beschränkungen pro Endpunkt.
2. Implementieren Sie exponentielles Backoff mit dem Retry-After Kopfzeile
3. Verwenden Sie einen dedizierten Endpunkt für unbegrenzten Inferenzdurchsatz.

FAQ

Wie viele Schlüssel kann ich erstellen?

Es gibt keine feste Begrenzung für API-Schlüssel. Erstellen Sie so viele, wie für verschiedene Anwendungen und Umgebungen benötigt werden.

Laufen Schlüssel ab?

Schlüssel laufen nicht automatisch ab. Sie bleiben gültig, bis sie widerrufen werden. Erwägen Sie die Implementierung einer Rotation aus Sicherheitsgründen.

Kann ich meinen Schlüssel nach der Erstellung einsehen?

Ja, die vollständigen Schlüsselwerte sind in der Schlüsselliste unter Settings > ProfileDie Plattform entschlüsselt und zeigt Ihre Schlüssel an, sodass Sie sie jederzeit kopieren können.

Sind Schlüssel regionsspezifisch?

Schlüssel funktionieren regionsübergreifend, greifen aber nur auf Daten in der Region Ihres Kontos zu.

Kann ich Schlüssel mit Teammitgliedern teilen?

Bessere Vorgehensweise: Lassen Sie jedes Teammitglied seinen eigenen Schlüssel erstellen. Bei Team-Arbeitsbereichen kann jedes Mitglied mit der Rolle „Editor“ oder höher Schlüssel erstellen, die für diesen Arbeitsbereich gelten.

📅 Erstellt vor 1 Monat ✏️ Aktualisiert vor 6 Tagen

Kommentare