Không gian làm việc

Lấy workspace hiện tại

Trả về không gian làm việc gắn với tiêu đề X-Api-Key. Không cần gửi workspace_id trong nội dung yêu cầu. is_beta là cờ chỉ đọc, mặc định tắt. Liên hệ nền tảng để mở; không thể tự sửa qua PATCH hoặc metadata.

GEThttps://api.unifyport.ai/v1/workspace

Kênh được hỗ trợ

all

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Tham số yêu cầu

Tiêu đề

X-Api-Key

stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Hiểu kết quả

Đánh giá kết quả theo các trường phản hồi và trạng thái HTTP của API này, rồi chọn bước tiếp theo từ các thao tác liên quan.

Phản hồi 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_used": 1,
    "account_quota_unlimited": false,
    "is_beta": false
  }
}

Nội dung phản hồi

is_beta

boolean

is_beta là cờ chỉ đọc, mặc định tắt. Liên hệ nền tảng để mở; không thể tự sửa qua PATCH hoặc metadata.

name

string

Tên hiển thị của workspace.

status

string

Trạng thái workspace: active hoặc inactive; inactive chặn xác thực của mọi API key.

enum: active, inactive

metadata

object

Nhãn môi trường của riêng bạn được lưu trên workspace.

account_quota

integer

Tổng sức chứa tài khoản chỉ đọc hiện có hiệu lực, bao gồm hạn mức miễn phí và hạn mức trả phí còn hiệu lực, không trừ số lượng đã dùng; hạn mức trả phí đã hết hạn không được tính.

format: uint64

account_quota_used

integer

Hạn mức tài khoản đang sử dụng, chỉ đọc. Tạo tài khoản sẽ chiếm hạn mức ngay, xóa tài khoản sẽ giải phóng hạn mức. Tài khoản đang chờ cấp quyền, đã dừng hoặc mất kết nối vẫn được tính. Khi hạn mức trả phí hết hạn, mức sử dụng có thể vượt account_quota; giá trị trả về là mức sử dụng thực tế.

format: uint64

account_quota_unlimited

boolean

Trường chỉ đọc được giữ lại để tương thích; chế độ hạn mức hiện tại luôn trả về false. Dung lượng tài khoản lấy theo account_quota.

Phản hồi

200

200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

401

Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code, giữ request_id. Sửa tham số, tiếp tục xác thực hoặc kiểm tra runtime tùy nguyên nhân. Xác nhận kết quả cũ trước khi thử lại thao tác gửi hoặc ghi. Tham chiếu mã lỗi

missing_api_key · 11000 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.
invalid_api_key · 11001 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.