查询用户空间列表

接口信息

接口地址:/api/v1/space/list

请求方式:GET

请求数据类型:无

响应数据类型:*/*

接口描述:

查询当前用户所在的空间列表

请求示例:

GET /api/v1/space/list

请求参数

请求头

参数名	类型	必填	描述	示例值
Authorization	string	是	API Key	`Bearer ak-xxxxeyJhbGciOiJIUzI1NiJ9`

响应参数:

参数名称	参数说明	类型	schema
code	业务状态码，0000 表示成功，其余失败	string
displayCode	源系统状态码，用于问题跟踪	string
message	错误描述信息	string
data	空间列表	array	SpaceDto
id	空间ID	integer(int64)
tenantId	租户ID	integer(int64)
name	空间名称	string
description	空间描述	string
icon	空间图标	string
type	空间类型，可用值: Personal, Team, Class	string
creatorId	创建者ID	integer(int64)
creatorName	创建者名称	string
modified	更新时间	string(date-time)
created	创建时间	string(date-time)
currentUserRole	当前用户在空间的角色，可用值: Owner, Admin, User	string
receivePublish	空间是否接收来自外部的发布	integer(int32)
allowDevelop	空间是否开启开发功能	integer(int32)
tid	跟踪唯一标识	string
success		boolean

响应示例:

javascript

{
	"code": "0000",
	"displayCode": "0000",
	"message": "success",
	"data": [
		{
			"id": 21,
			"tenantId": 1,
			"name": "ceshi2334",
			"description": null,
			"icon": null,
			"type": "Team",
			"creatorId": 1,
			"creatorName": "fei",
			"modified": "2026-04-13T12:13:46.000+00:00",
			"created": "2025-12-10T06:30:00.000+00:00",
			"currentUserRole": "Owner",
			"receivePublish": 0,
			"allowDevelop": 0
		}
	],
	"tid": "123456",
	"success": true
}

CURL示例

shell

curl 'http://127.0.0.1:8081/api/v1/space/list' \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"code":"0000","displayCode":"0000","message":"success","data":[...],"tid":"123456","success":true}

测试用例

#	场景	状态码	结果
1	查询用户空间列表	0000	成功，返回用户所在的全部空间

TS模板示例

// 空间信息
export interface SpaceDto {
  /* 空间ID */
  id: number;
  /* 租户ID */
  tenantId: number;
  /* 空间名称 */
  name: string;
  /* 空间描述 */
  description: string | null;
  /* 空间图标 */
  icon: string | null;
  /* 空间类型: Personal, Team, Class */
  type: 'Personal' | 'Team' | 'Class';
  /* 创建者ID */
  creatorId: number;
  /* 创建者名称 */
  creatorName: string;
  /* 更新时间 */
  modified: string;
  /* 创建时间 */
  created: string;
  /* 当前用户在空间的角色: Owner, Admin, User */
  currentUserRole: 'Owner' | 'Admin' | 'User' | null;
  /* 是否接收来自外部的发布 */
  receivePublish: number;
  /* 是否开启开发功能 */
  allowDevelop: number;
}

// 响应接口
export interface SpaceListRes {
  code: string;
  displayCode: string;
  message: string;
  data: SpaceDto[];
  tid: string;
  success: boolean;
}

/** 
 * 查询用户空间列表
 * @returns
 */
export function getSpaceList(): Promise<SpaceListRes> {
  return request.get(`/api/v1/space/list`);
}

查询用户空间列表 ​

接口信息 ​

请求参数 ​

查询用户空间列表

接口信息

请求参数