YOLO Vision 2026:

API Keys#

Khóa API Ultralytics Platform cho phép truy cập theo chương trình một cách bảo mật cho việc huấn luyện từ xa, suy luận và tự động hóa. Tạo các khóa có tên với mã hóa AES-256-GCM cho các trường hợp sử dụng khác nhau.

Ultralytics Platform Settings API Keys Tab Key List

Chỉ chủ sở hữu

Chỉ chủ sở hữu không gian làm việc mới có thể tạo, xem hoặc thu hồi các API key của không gian làm việc, vì một key xác thực dưới tư cách là chủ sở hữu không gian làm việc. Các thành viên có bất kỳ vai trò nào khác sẽ nhìn thấy một ghi chú trên tab thay vì danh sách key. Bản thân các API key không thể tạo hoặc thu hồi các API key khác. Ngoại lệ duy nhất là On Premise worker keys, được thu hồi bằng cách ngắt kết nối máy chủ khỏi tích hợp On Premise.

Tạo API Key#

Tạo một API key mới:

  1. Đi tới Settings > API Keys
  2. Nhấp vào Create Key
  3. Nhập tên cho key (ví dụ: "Training Server")
  4. Nhấp vào Create Key

Ultralytics Platform Settings API Keys Tab Create API Key Dialog

Tên Key#

Đặt cho key của bạn một cái tên mang tính mô tả:

  • training-server - Dành cho máy huấn luyện từ xa
  • ci-pipeline - Dành cho tích hợp CI/CD
  • local-dev - Dành cho phát triển cục bộ

Hiển thị Key#

Sau khi tạo, key được hiển thị trong hộp thoại xác nhận:

Ultralytics Platform Settings API Keys Tab API Key Created Copy Dialog

Sao chép Key của bạn

Hãy sao chép key của bạn sau khi tạo để dễ tra cứu. Các key cũng hiển thị trong danh sách key — nền tảng giải mã và hiển thị đầy đủ giá trị key để bạn có thể sao chép bất cứ lúc nào.

Định dạng Key#

Các API key tuân theo định dạng sau:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4
  • Tiền tố: ul_ xác định các khóa Ultralytics
  • Phần thân: 40 ký tự thập lục phân ngẫu nhiên
  • Tổng cộng: 43 ký tự

Bảo mật Key#

  • Key được lưu trữ với mã hóa AES-256-GCM, không bao giờ lưu dưới dạng văn bản thuần túy
  • 11 ký tự đầu tiên (ul_ cộng với 8 ký tự thập lục phân) đóng vai trò là tiền tố hiển thị, do đó một key có thể được nhận diện mà không làm lộ nó

Sử dụng API Keys#

Biến môi trường#

Thiết lập key của bạn dưới dạng biến môi trường:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Xác thực và lưu khóa bằng cách sử dụng YOLO CLI:

yolo login YOUR_API_KEY

Xóa khóa đã lưu bằng yolo logout.

Tiêu đề HTTP#

Bao gồm key trong các yêu cầu API:

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

Hoặc truyền nó vào Python SDK (pip install "ultralytics-platform>=0.1.5"), SDK này cũng đọc ULTRALYTICS_API_KEY:

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Xem Tài liệu tham khảo REST API để biết tất cả các điểm cuối có sẵn.

Huấn luyện từ xa (Remote Training)#

Bật tính năng truyền phát số liệu (metric streaming) bằng key của bạn.

Cài đặt hoặc cập nhật gói ultralytics trước khi bắt đầu:

pip install -U ultralytics
export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Xem Huấn luyện trên đám mây để biết hướng dẫn huấn luyện từ xa hoàn chỉnh.

Quản lý Keys#

Xem các Key#

Tất cả các khóa được liệt kê trên tab Settings > API Keys:

Mỗi thẻ key hiển thị tên key, giá trị key có thể sao chép, thời gian tạo tương đối và nút thu hồi.

Thu hồi Key#

Thu hồi key đã bị xâm phạm hoặc không còn cần thiết:

  1. Tìm key trong phần API Keys
  2. Nhấp vào nút Thu hồi (thùng rác)
  3. Xác nhận thu hồi
Hiệu lực ngay lập tức

Việc thu hồi diễn ra ngay lập tức và vĩnh viễn — bản ghi key bị xóa chứ không phải vô hiệu hóa. Bất kỳ ứng dụng nào sử dụng key sẽ ngừng hoạt động.

Tạo lại Key#

Nếu một key bị xâm phạm:

  1. Tạo một key mới với cùng tên
  2. Cập nhật các ứng dụng của bạn
  3. Thu hồi key cũ

API Keys của Không gian làm việc (Workspace)#

Các API key được giới hạn trong không gian làm việc đang hoạt động:

  • Không gian làm việc cá nhân: Các key xác thực dưới dạng tài khoản cá nhân của bạn
  • Không gian làm việc nhóm: Key xác thực dưới tư cách là chủ sở hữu không gian làm việc nhóm, với đầy đủ quyền của chủ sở hữu trong không gian làm việc đó

Khi chuyển đổi không gian làm việc ở thanh bên, phần API Keys hiển thị các key cho không gian làm việc đó. Vì một key không gian làm việc mang các quyền của chủ sở hữu, chỉ chủ sở hữu không gian làm việc mới có thể tạo, xem hoặc thu hồi nó. Xem phần Teams để biết chi tiết về vai trò.

Key Worker On Premise#

Kết nối một máy chủ On Premise sẽ tạo ra một worker key riêng biệt. Các worker key được quản lý từ tích hợp On Premise thay vì tab này, không bao giờ được liệt kê cùng với các API key của bạn, và được thu hồi bằng cách ngắt kết nối máy chủ — điều này cũng đồng thời hủy các tác vụ đang đợi và đang chạy của máy chủ đó.

Các thực tiễn tốt nhất về bảo mật#

Nên#

  • Lưu trữ key trong biến môi trường
  • Sử dụng các key riêng biệt cho các môi trường khác nhau
  • Thu hồi các key không sử dụng ngay lập tức
  • Xoay vòng các key định kỳ
  • Sử dụng các tên mang tính mô tả để xác định mục đích của key

Không nên#

  • Commit các key vào hệ thống quản lý phiên bản
  • Chia sẻ key giữa các ứng dụng
  • Ghi log key trong đầu ra ứng dụng
  • Nhúng key vào mã phía client

Xoay vòng Key#

Xoay vòng các key định kỳ vì mục đích bảo mật:

  1. Tạo key mới với cùng tên
  2. Cập nhật các ứng dụng để sử dụng key mới
  3. Xác minh các ứng dụng hoạt động chính xác
  4. Thu hồi key cũ
Lịch trình xoay vòng

Hãy cân nhắc xoay vòng các key sau mỗi 90 ngày đối với các ứng dụng nhạy cảm.

Khắc phục sự cố#

Lỗi Key không hợp lệ#

Error: Invalid API key

Các giải pháp:

  1. Xác minh rằng khóa được sao chép chính xác (bao gồm cả tiền tố ul_)
  2. Kiểm tra xem key đã bị thu hồi chưa
  3. Xác nhận biến môi trường đã được thiết lập
  4. Đảm bảo bạn đang sử dụng ultralytics>=8.4.120

Quyền bị từ chối#

Error: Permission denied for this operation

Các giải pháp:

  1. Xác minh bạn là chủ sở hữu tài nguyên hoặc có quyền truy cập không gian làm việc phù hợp
  2. Kiểm tra xem key có thuộc về đúng không gian làm việc hay không
  3. Nếu bạn đang quản lý các key trong một không gian làm việc nhóm, hãy xác nhận bạn là chủ sở hữu không gian làm việc — các vai trò khác sẽ nhận được Workspace owner access required
  4. Tạo key mới nếu cần

Giới hạn tốc độ (Rate Limited)#

Error: Rate limit exceeded

Các giải pháp:

  1. Giảm tần suất yêu cầu — xem bảng giới hạn tốc độ để biết giới hạn cho từng danh mục
  2. Thực hiện thuật toán lùi theo cấp số nhân (exponential backoff) sử dụng tiêu đề Retry-After
  3. Sử dụng một điểm cuối chuyên dụng khi bạn cần dung lượng suy luận độc lập

Câu hỏi thường gặp#

  • Không có giới hạn cứng về số lượng API key. Hãy tạo bao nhiêu key tùy ý cho các ứng dụng và môi trường khác nhau.

  • Các key không tự động hết hạn. Chúng vẫn hợp lệ cho đến khi bị thu hồi. Hãy cân nhắc thực hiện xoay vòng để đảm bảo bảo mật.

  • Có, giá trị khóa đầy đủ hiển thị trong danh sách khóa trên Settings > API Keys. Nền tảng giải mã và hiển thị các khóa của bạn để bạn có thể sao chép chúng bất kỳ lúc nào.

  • Các key hoạt động trên nhiều khu vực nhưng chỉ truy cập dữ liệu trong khu vực tài khoản của bạn.

  • Không — một key không gian làm việc nhóm xác thực dưới tư cách là chủ sở hữu không gian làm việc, vì vậy chỉ chủ sở hữu mới có thể tạo hoặc xem key, và việc chia sẻ nó đồng nghĩa với việc bàn giao các quyền của chủ sở hữu. Thay vào đó, hãy yêu cầu mỗi thành viên tạo một key trong không gian làm việc cá nhân của riêng họ, và yêu cầu chủ sở hữu tạo một key không gian làm việc chuyên dụng cho các tự động hóa được chia sẻ như CI.

  • Không. Một key thuộc về không gian làm việc nơi nó được tạo ra và chỉ truy cập được các tài nguyên của không gian làm việc đó. Hãy tạo một key riêng cho mỗi không gian làm việc mà bạn tự động hóa.

Người đóng góp
GLglenn-jocher14SEsergiuwaxmann2LAlaodouya1MYmykolaxboiko1LALaughing-q1

Bình luận