Cài đặt access key
SDK cần được cấu hình với khóa truy cập của bạn, khóa này có sẵn trong Bảng điều khiển Locker Secrets của bạn. Các thông tin nên được giữ một cách bí mật nhất, không được phép lộ lọt ở bất cứ đâu. Nếu khóa truy cập bị lộ lọt, bạn cần thu hồi chúng ngay lập tức. Biến môi trường (Environment variable) là một phương án được khuyến nghị để lưu trữ các khóa điều khiển này trong phiên sử dụng của bạn.Với Linux/MacOS
Với Windows
PowerShellapi_base (mặc định là https://api.locker.io/locker_secrets). Nếu bạn cần thiết lập các tiêu đề tùy chỉnh, bạn cũng cần thiết lập giá trị headers trong tham số options. Bây giờ, bạn có thể sử dụng SDK để lấy hoặc đặt các giá trị:
Locker() hoặc chỉnh sửa file xác thực (~/.locker/credentials), nhưng cách này không được chúng tôi khuyến khích sử dụng:
List secrets
Sử dụng phương thức.list() để lấy tất cả các secret trong dự án của bạn.
Get giá trị secrets
Hàm này sẽ lấy giá trị bí mật bằng một khóa. Nếu khóa không tồn tại, SDK sẽ trả vềdefault_value:
environment_name. Nếu khóa không tồn tại, SDK sẽ trả về giá trị mặc định:
Tạo mới secrets
Dùng hàm.create() để tạo mới secret:
Cập nhật secrets
Dùng hàm.modify() để cập nhật giá trị secrets:
List environments
Dùng hàm.list_environments() để lấy tất cả các môi trường trong dự án của bạn:
Retrieve an environment
Để lấy một môi trường theo tên, sử dụng.get_environment():
Tạo mới environment
Để tạo mới môi trường, sử dụng.create_environment():
Cập nhật environment
Để cập nhậtexternal_url của môi trường bằng tên, sử dụng .modify_environment():
Error Handling
SDK của Locker Secret cung cấp một số loại lỗi. Chúng có thể phản ánh các sự kiện bên ngoài, như thông tin đăng nhập không hợp lệ, gián đoạn kết nối mạng, hoặc các vấn đề về mã lỗi như các cuộc gọi API không hợp lệ. Nếu một vấn đề ngay lập tức ngăn chặn một hàm tiếp tục, SDK sẽ ném ra một ngoại lệ. Đây là một thực hành tốt để bắt và xử lý các ngoại lệ. Sử dụng cú pháptry/except của Python và bắt locker.error.LockerError hoặc các lớp con của nó để xử lý các ngoại lệ của Locker.
locker.error.LockerError và các lớp con của nó. Sử dụng tài liệu cho mỗi lớp để biết cách phản ứng.
| Code | HTTP Status | Name | Class | Description |
|---|---|---|---|---|
unauthorized | 401 | Authentication Error | locker.error.AuthenticationError | Invalid access_client_id or invalid secret_access_key |
permission_denied | 403 | Permission Denied Error | locker.error.PermissionDeniedError | Your credential does not have enough permission to execute this operation |
rate_limit | 429 | Rate Limit Error | locker.error.RateLimitError | Too many requests |
not_found | 404 | Resource Not Found | locker.error.ResourceNotFoundError | The requested resource is not found |
server_error | 500 | API Server Error | locker.error.APIServerError | Something went wrong on Locker’s end (These are rare) |
http_error | 503 | API Connect Error | locker.error.APIConnectionError | The request to API server error. Check your network connection |
cli_error | — | CLI Run Error | locker.error.CliRunError | The encryption/decryption binary runs error by invalid local data, process interruptions |
locker_error | — | General Locker Error | locker.error.LockerError | The general error |
Logging
Thư viện có thể được cấu hình để phát ra thông tin logging giúp bạn hiểu rõ hơn về những gì đang diễn ra. Có một số cấp độ:debug, info, warning, error.
Cấp độ info thường phù hợp nhất cho việc sử dụng trong môi trường production, nhưng debug cũng có sẵn để có thêm chi tiết.
Cách kích hoạt logging
1. Thiết lập biến môi trườngLOCKER_LOG thành một trong các giá trị: debug, info, warning hoặc error
log khi khởi tạo đối tượng Locker
logging của Python