跳到主要内容

5. 查询工作空间列表

描述: 获取用户所有工作空间列表信息。

5.1. 接口URL

 Post http://${server-host}:${server-port}/api/v1/listWorkspaces

5.2. 接口入参

字段类型是否必填描述
userKeyStringY激活码
pageNumberintN页码信息(默认1)
pageSizeintN页大小信息(默认10)

入参示例

{
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"pageNumber": 1,
"pageSize": 10
}

5.3. 接口出参

字段名字段类型描述
codeint状态码
messageString描述信息
dataObject数据信息

data数据结构

字段名字段类型描述
recordsarray工作空间列表信息
workspaceIdString工作空间ID
workspaceNameString工作空间名称
dbTypeString数据库类型
createTimeString创建时间
numberOfAnalysisint工作空间分析个数
latestAnalysisTimeString最近一次分析时间
statusString工作空间创建状态
totalString总数
sizeString页大小
currentString页码
pagesString总页数

出参示例

{
"code": 200,
"message": "操作成功",
"data": {
"records": [
{
"workspaceId": "1730411624641736706",
"workspaceName": "api-online-pawsql20231201102054",
"dbType": "mysql",
"createTime": "2023-12-01 10:20:54",
"numberOfAnalysis": 8,
"latestAnalysisTime": "2023-12-01 16:24:17",
"status": "success"
},
{
"workspaceId": "1730187810133712898",
"workspaceName": "api-service@pawsql.comoffline-null2023-11-30 19:31:26",
"dbType": "mysql",
"createTime": "2023-11-30 19:31:26",
"numberOfAnalysis": 3,
"latestAnalysisTime": "2023-12-01 09:50:16",
"status": "success"
}
],
"total": "2",
"size": "10",
"current": "1",
"orders": [],
"searchCount": true,
"pages": "1"
}
}