6. 查询优化列表
描述: 获取用户(指定工作空间的)优化列表
6.1. 接口URL
Post http://${server-host}:${server-port}/api/v1/listAnalyses
6.2. 接口入参
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
userKey | String | Y | 激活码 |
workspaceId | String | N | 工作空间ID(为空时返回用户所有优化信息列表) |
pageNumber | int | N | 页码信息(默认1) |
pageSize | int | N | 页大小信息(默认10) |
入参示例
{
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"workspaceId": "1730187810133712898",
"pageNumber": 1,
"pageSize": 10
}
6.3. 接口出参
字段名 | 字段类型 | 描述 |
---|---|---|
code | int | 状态码 |
message | String | 描述信息 |
data | Object | 数据信息 |
data数据结构
字段名 | 字段类型 | 描述 |
---|---|---|
records | array | 工作空间列表信息 |
analysisId | String | 分析ID |
analysisName | String | 分析名称 |
workspaceId | String | 工作空间ID |
workspaceName | String | 工作空间名称 |
status | String | 分析执行状态 |
numberOfQuery | int | 分析的query数量 |
numberOfSyntaxError | int | 语法错误数目 |
numberOfIndex | int | 推荐出来的索引数量 |
numberOfRewrite | int | 重写出来的query数量 |
numberOfViolations | int | 违反的规则数量 |
numberOfViolatedQuery | int | 违反规则的query数量 |
performanceImprove | double | 性能提升比例 |
createUserId | String | 创建人ID |
createUserName | String | 创建人名称 |
createTime | String | 创建时间 |
total | String | 总数 |
size | String | 页大小 |
current | String | 页码 |
pages | String | 总页数 |
出参示例
{
"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"
}
}