跳到主要内容

6. 查询优化列表

描述: 获取用户(指定工作空间的)优化列表

6.1. 接口URL

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

6.2. 接口入参

字段类型是否必填描述
userKeyStringY激活码
workspaceIdStringN工作空间ID(为空时返回用户所有优化信息列表)
pageNumberintN页码信息(默认1)
pageSizeintN页大小信息(默认10)

入参示例

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

6.3. 接口出参

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

data数据结构

字段名字段类型描述
recordsarray工作空间列表信息
analysisIdString分析ID
analysisNameString分析名称
workspaceIdString工作空间ID
workspaceNameString工作空间名称
statusString分析执行状态
numberOfQueryint分析的query数量
numberOfSyntaxErrorint语法错误数目
numberOfIndexint推荐出来的索引数量
numberOfRewriteint重写出来的query数量
numberOfViolationsint违反的规则数量
numberOfViolatedQueryint违反规则的query数量
performanceImprovedouble性能提升比例
createUserIdString创建人ID
createUserNameString创建人名称
createTimeString创建时间
totalString总数
sizeString页大小
currentString页码
pagesString总页数

出参示例

{
"code": 200,
"message": "操作成功",
"data": {
"records": [
{
"analysisId": "1730418304666488833",
"analysisName": "api-20231201104727",
"workspaceId": "1730411624641736706",
"workspaceName": "api-online-pawsql20231201102054",
"status": "success1",
"numberOfQuery": 1,
"numberOfSyntaxError": 3,
"numberOfIndex": 0,
"numberOfRewrite": 1,
"numberOfViolations": 1,
"numberOfViolatedQuery": 1,
"performanceImprove": null,
"createUserId": "1730187778361860097",
"createUserName": "service@pawsql.com",
"createTime": "2023-12-01 10:47:28"
},
{
"analysisId": "1730414868667498498",
"analysisName": "api-20231201103348",
"workspaceId": "1730411624641736706",
"workspaceName": "api-online-pawsql20231201102054",
"status": "success1",
"numberOfQuery": 1,
"numberOfSyntaxError": 3,
"numberOfIndex": 0,
"numberOfRewrite": 1,
"numberOfViolations": 1,
"numberOfViolatedQuery": 1,
"performanceImprove": null,
"createUserId": "1730187778361860097",
"createUserName": "service@pawsql.com",
"createTime": "2023-12-01 10:33:48"
},
{
"analysisId": "1730413501622149121",
"analysisName": "api-20231201102822",
"workspaceId": "1730411624641736706",
"workspaceName": "api-online-pawsql20231201102054",
"status": "failed",
"numberOfQuery": null,
"numberOfSyntaxError": null,
"numberOfIndex": null,
"numberOfRewrite": null,
"numberOfViolations": null,
"numberOfViolatedQuery": null,
"performanceImprove": null,
"createUserId": "1730187778361860097",
"createUserName": "service@pawsql.com",
"createTime": "2023-12-01 10:28:22"
}
],
"total": "3",
"size": "10",
"current": "1",
"orders": [],
"searchCount": true,
"pages": "1"
}
}