Skip to content

获取工作空间

GET/web/v1/workspaces/{workspaceBizId} JWT

通过业务 ID 获取工作空间详情。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 系统注入的请求头(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx)、X-Request-Id(Gateway)

请求参数

NameTypeRequiredInDescription
workspaceBizIdStringRequiredpath工作空间业务 ID

成功响应

状态码: 200 OK

成功 200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "WS_INVITE_TEST_001",
    "institutionBizId": "INST_INVITE_TEST_001",
    "entityBizId": null,
    "workspaceName": "测试工作空间",
    "workspaceTimezone": "UTC",
    "workspaceStatus": {
      "value": 10010701,
      "name": "ACTIVE",
      "code": "ACTIVE"
    },
    "workspaceKind": {
      "value": 10010801,
      "name": "LIVE",
      "code": "LIVE"
    },
    "extraData": null,
    "createdAt": "2026-03-22T10:30:00Z",
    "updatedAt": "2026-03-22T10:30:00Z"
  }
}

响应字段

字段类型说明
bizIdString工作空间唯一业务 ID
institutionBizIdString所属机构业务 ID
entityBizIdString关联实体业务 ID(可为空)
workspaceNameString工作空间显示名称
workspaceTimezoneStringIANA 时区标识
workspaceStatusObject状态枚举,含 valuenamecode
workspaceKindObject工作空间类型(LIVE / SANDBOX)
extraDataString自由格式 JSON 字符串(可为空)
createdAtStringISO 8601 创建时间
updatedAtStringISO 8601 最后更新时间

错误响应

未授权 401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

说明

  • 需要工作空间成员身份。
  • 返回完整的工作空间对象,包含状态和类型枚举。

SlaunchX Internal Documentation