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

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

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

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

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

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

ใช้ 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 ตามเอกสาร 204 สำเร็จไม่มีเนื้อหา ใช้ X-Request-Id เพื่อตรวจสอบ ขั้นตอนต่อไปอยู่ในการทำงานที่เกี่ยวข้อง

การตอบกลับ 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
  }
}

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

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 หายไปหรือไม่ถูกต้อง

500

Internal Server Error

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

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

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

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่