API 参考

工作区

获取当前工作区

返回与 X-Api-Key 请求头关联的工作区。请求体中无需再传 workspace_id。

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

调用前准备

在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。

请求参数

请求头

X-Api-Key
string必填

工作区 API Key，工作区由该请求头解析得到。

请求体

该接口无需 JSON 请求体。

如何理解结果

按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体，排查时使用 X-Request-Id。下一步操作见相关链接。

响应 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
  }
}

响应体

name
string

工作区显示名。

status
string

工作区状态：active 或 inactive；inactive 时全部 API Key 无法鉴权。

enum: active, inactive

metadata
object

存储在工作区上的自有环境标签。

account_quota
integer

当前生效的只读账号总容量，包含免费额度和有效期内的付费额度，不扣除已用数量；已到期的付费额度不计入。

format: uint64

account_quota_used
integer

当前已占用的只读账号额度，账号创建后即占用，删除后释放；待授权、停止或断线的账号仍计入。付费额度到期后，已用额度可能超过 account_quota，按实际已用值返回。

format: uint64

account_quota_unlimited
boolean

兼容保留的只读字段，当前配额模式固定返回 false；账号容量以 account_quota 为准。

响应

200

200 OK

请求成功，响应体示例如上。

401

未授权

X-Api-Key 请求头缺失或无效。

500

服务端错误

服务端遇到了未预期的错误。

失败后怎么处理

检查 HTTP 状态和 error.code/numeric_code，保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果，避免重复操作。 错误码参考

invalid_request · 10000 · 400
检查必填字段、格式和渠道条件，修正请求后再调用。
invalid_api_key · 11001 · 401
检查 X-Api-Key 是否正确、工作区是否有效。