เอกสารอ้างอิง API

พื้นที่ทำงาน

อัปเดต พื้นที่ทำงานปัจจุบัน

อัปเดต name และ status ของ workspace โดยทั้งสองฟิลด์จำเป็น status รับ active หรือ inactive และ inactive จะบล็อกการยืนยันตัวตนของ API key ทั้งหมด หากละ metadata จะคงค่าเดิม ส่ง metadata={} เพื่อล้างค่า และห้ามส่ง null is_beta เป็นสถานะแบบอ่านอย่างเดียว ปิดโดยค่าเริ่มต้น ติดต่อแพลตฟอร์มเพื่อขอสิทธิ์ ไม่สามารถเปลี่ยนด้วย PATCH หรือ metadata

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

ช่องทางที่รองรับ

all

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

พารามิเตอร์คำขอ

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

Content-Type
stringจำเป็น

ใช้ application/json เมื่อต้องส่งเนื้อหาของคำขอเป็น JSON

เนื้อหาของคำขอ

name
stringจำเป็น

ชื่อแสดงผลของ workspace

minLength: 1

status
stringจำเป็น

สถานะ workspace: active หรือ inactive โดย inactive ทำให้ API key ทั้งหมดยืนยันตัวตนไม่ได้

enum: active, inactive

metadata
object

metadata ของ workspace สำหรับ PATCH ให้ละไว้เพื่อคงค่า ส่ง {} เพื่อล้าง และห้ามส่ง null

ทำความเข้าใจผลลัพธ์

พิจารณาผลจากฟิลด์คำตอบและสถานะ HTTP ของ API นี้ แล้วเลือกขั้นตอนถัดไปจากคำสั่งที่เกี่ยวข้อง

การตอบกลับ 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,
    "is_beta": false
  }
}

เนื้อหาการตอบกลับ

is_beta
boolean

is_beta เป็นสถานะแบบอ่านอย่างเดียว ปิดโดยค่าเริ่มต้น ติดต่อแพลตฟอร์มเพื่อขอสิทธิ์ ไม่สามารถเปลี่ยนด้วย PATCH หรือ metadata

name
string

ชื่อแสดงผลของ workspace

status
string

สถานะ workspace: active หรือ inactive โดย inactive บล็อก API key ทั้งหมด

enum: active, inactive

metadata
object

label สภาพแวดล้อมของคุณเองที่เก็บไว้บน workspace

account_quota
integer

ความจุบัญชีแบบอ่านอย่างเดียวที่มีผลในปัจจุบัน รวมโควตาฟรีและโควตาแบบชำระเงินที่ยังไม่หมดอายุ โดยไม่หักจำนวนที่ใช้ไป; โควตาแบบชำระเงินที่หมดอายุแล้วจะไม่ถูกนับ

format: uint64

account_quota_used
integer

โควตาบัญชีที่ใช้อยู่ในปัจจุบันแบบอ่านอย่างเดียว การสร้างบัญชีจะใช้โควตาทันทีและการลบบัญชีจะคืนโควตา บัญชีที่รอการอนุญาต หยุดทำงาน หรือขาดการเชื่อมต่อยังถูกนับ เมื่อโควตาแบบชำระเงินหมดอายุ จำนวนที่ใช้อาจเกิน account_quota โดยจะคืนจำนวนที่ใช้จริง

format: uint64

account_quota_unlimited
boolean

ฟิลด์อ่านอย่างเดียวที่สงวนไว้เพื่อความเข้ากันได้ โหมดโควตาปัจจุบันจะคืนค่า false เสมอ; ให้ใช้ account_quota เป็นความจุบัญชี

การตอบกลับ

200

200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400

Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401

Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

403

Forbidden

ระบบระบุคำขอได้ แต่ไม่อนุญาตให้ดำเนินการนี้

404

Not Found

ไม่พบทรัพยากรที่ร้องขอ โปรดตรวจสอบ error.code ร่วมกับการดำเนินการปัจจุบัน

500

Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

เมื่อคำขอล้มเหลว

ตรวจ HTTP และ error.code/numeric_code เก็บ request_id แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

อ่านสถานะ HTTP, error.code และ error.numeric_code ร่วมกับคำสั่งที่เรียก รหัสตัวเลขเป็นสตริง เก็บ request_id เพื่อตรวจปัญหา ค่านี้ไม่ใช่คีย์ป้องกันการทำซ้ำหรือรหัสงาน

invalid_request · 10000 · 400

ตรวจ JSON และฟิลด์ที่จำเป็น

วิธีจัดการและลองใหม่: แก้พารามิเตอร์ตามคำสั่งและเงื่อนไขช่องทางก่อนเรียกใหม่ การส่งคำขอผิดแบบเดิมซ้ำไม่ช่วยแก้ข้อผิดพลาด

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 400 · 10000
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid request parameters"
  }
}
invalid_target_workspace · 11003 · 400

เวิร์กสเปซเป้าหมายที่กำหนดทับว่างหรือรูปแบบไม่ถูกต้อง ให้ลบเฮดเดอร์กำหนดทับและใช้ API Key ของเวิร์กสเปซเป้าหมาย

เงื่อนไข: ใช้เมื่อคำขอมีเฮดเดอร์ X-Workspace-Id เพื่อระบุเวิร์กสเปซทับ

วิธีจัดการและลองใหม่: แก้พารามิเตอร์ตามคำสั่งและเงื่อนไขช่องทางก่อนเรียกใหม่ การส่งคำขอผิดแบบเดิมซ้ำไม่ช่วยแก้ข้อผิดพลาด

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 400 · 11003
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}
update_workspace_failed · 41001 · 400

การทำงานถูกปฏิเสธ ตรวจคำขอและเก็บ request_id

วิธีจัดการและลองใหม่: อ่านสถานะปัจจุบันและยืนยันผลการเปลี่ยนแปลงครั้งก่อนก่อนทำซ้ำ เก็บ request_id และอย่าเขียนซ้ำอัตโนมัติเมื่อยังไม่ทราบผล

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 400 · 41001
{
  "request_id": "req_example",
  "error": {
    "code": "update_workspace_failed",
    "numeric_code": "41001",
    "message": "Failed to update workspace"
  }
}
invalid_api_key · 11001 · 401

ตรวจว่า API Key ถูกต้องและเปิดใช้งานอยู่

วิธีจัดการและลองใหม่: เก็บ request_id และรหัสแบบมีโครงสร้าง ตรวจคำสั่งปัจจุบันก่อนเลือกการดำเนินการถัดไป

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 401 · 11001
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}
missing_api_key · 11000 · 401

เพิ่มส่วนหัว X-Api-Key

วิธีจัดการและลองใหม่: เก็บ request_id และรหัสแบบมีโครงสร้าง ตรวจคำสั่งปัจจุบันก่อนเลือกการดำเนินการถัดไป

ตัวอย่าง · 401 · 11000
{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}
workspace_override_forbidden · 11002 · 403

คำขอพยายามระบุเวิร์กสเปซทับโดย API Key นี้ไม่มีสิทธิ์ ให้ลบเฮดเดอร์กำหนดทับและใช้ API Key ของเวิร์กสเปซเป้าหมาย

เงื่อนไข: ใช้เมื่อคำขอมีเฮดเดอร์ X-Workspace-Id เพื่อระบุเวิร์กสเปซทับ

วิธีจัดการและลองใหม่: เก็บ request_id และรหัสแบบมีโครงสร้าง ตรวจคำสั่งปัจจุบันก่อนเลือกการดำเนินการถัดไป

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 403 · 11002
{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}
target_workspace_not_found · 11004 · 404

ไม่พบเวิร์กสเปซที่กำหนดทับหรือใช้งานไม่ได้ ตรวจเจ้าของเวิร์กสเปซ ลบเฮดเดอร์กำหนดทับ และใช้ API Key ของเวิร์กสเปซเป้าหมาย การส่งซ้ำไม่เพิ่มสิทธิ์

เงื่อนไข: ใช้เมื่อคำขอมีเฮดเดอร์ X-Workspace-Id เพื่อระบุเวิร์กสเปซทับ

วิธีจัดการและลองใหม่: ตรวจรหัสเป้าหมาย เจ้าของทรัพยากร และเวิร์กสเปซปัจจุบัน อย่าถือว่าเป้าหมายที่ยืนยันแล้วว่าไม่มีหรือเข้าไม่ถึงเป็นความขัดข้องชั่วคราวที่ควรลองซ้ำอัตโนมัติ

JSON ตัวอย่าง โดย message เปลี่ยนตามสาเหตุจริง · 404 · 11004
{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}