查看 Markdown
POST/api/project/create

创建项目

为当前身份主体创建项目。项目目录位于项目存储空间的 projects 目录下,目录名在创建时固定,后续改名不会修改已有文件路径。创建为同步操作,成功后项目立即可用;项目存储空间尚未就绪时不阻断创建,仅在首次创建会话时校验存储空间。调用方无需也不能指定其他身份主体。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)1 个字段

namestringrequired

项目展示名称。创建时内核据此生成稳定目录名;后续改名不会修改目录路径

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/project/list

分页查询项目

分页返回当前身份主体拥有的项目,按创建时间倒序。调用方无需也不能指定其他身份主体。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数2 个字段

pageintegernullable

页码,从1开始

pageSizeintegernullable

每页记录数,最大100

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/project/detail

查询项目详情

查询当前身份主体拥有的项目详情。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

projectIdintegerrequired

项目ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/project/updateName

修改项目名称

仅修改项目展示名称;创建时确定的项目存储空间目录路径不会改变。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

projectIdintegerrequired

项目ID

namestringrequired

新的项目展示名称;不会修改已确定的项目目录路径

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
DELETE/api/project/delete

删除项目

删除项目元数据与当前成员关系。为避免误删用户文件,不会删除项目存储空间中的项目目录或文件。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

projectIdintegerrequired

项目ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/project/session/list

分页查询项目会话

查询当前身份主体指定项目下的会话。临时会话和其他项目会话不会返回。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数3 个字段

projectIdintegerrequired

项目ID

pageintegernullable

页码,从1开始

pageSizeintegernullable

每页记录数,最大100

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理