Không gian làm việc

Cập nhật workspace hiện tại

Cập nhật name và status của workspace; cả hai trường đều bắt buộc. status nhận active hoặc inactive, trong đó inactive chặn xác thực của mọi API key. Bỏ qua metadata để giữ giá trị hiện tại, gửi metadata={} để xoá và không được gửi null.

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

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.

Yêu cầu

curl -X PATCH "https://api.unifyport.ai/v1/workspace" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Production Workspace",
  "status": "active",
  "metadata": {
    "region": "global",
    "env": "production"
  }
}'

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.

Content-Type

stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Nội dung yêu cầu

name

stringbắt buộc

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

minLength: 1

status

stringbắt buộc

Trạng thái workspace: active hoặc inactive. inactive khiến mọi API key trong workspace không thể xác thực.

enum: active, inactive

metadata

object

Metadata workspace. Với PATCH, bỏ qua để giữ nguyên, gửi {} để xoá; null không hợp lệ.

Hiểu kết quả

Đọc trường phản hồi và trạng thái HTTP được mô tả. Thành công 204 không có nội dung; dùng X-Request-Id để chẩn đoán. Xem thao tác liên quan cho bước tiếp theo.

Phản hồi 200 OK

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

Nội dung phản hồi

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.

400

Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

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

invalid_request · 10000 · 400: Kiểm tra trường bắt buộc, định dạng và điều kiện kênh rồi sửa yêu cầu.
invalid_api_key · 11001 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.