接口功能介绍
获取参数模板列表信息。
接口约束
无
URI
GET /v1/open-api/parameter/parameter-groups
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
parameterGroupName | 否 | String | 模板名称 | Default-5.7 | |
engineVersion | 否 | String | 引擎版本 | 5.7 | |
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 页大小 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
returnObj | 否 | Object | 返回对象 | returnObj | |
message | 否 | String | 结果信息 | success |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
endRow | 是 | Integer | 终行 | 2 | |
firstPage | 是 | Integer | 第一页 | true | |
hasNextPage | 是 | Boolean | 是否有后一页 | false | |
hasPreviousPage | 是 | Boolean | 是否有前一页 | false | |
isFirstPage | 是 | Boolean | 是否第一页 | true | |
isLastPage | 是 | Boolean | 是否最后一页 | true | |
lastPage | 是 | Integer | 最后一页 | 1 | |
navigatepageNums | 是 | Array of Integers | 页码 | [1] | |
navigateFirstPage | 是 | Integer | 导航条上的第一页 | 1 | |
navigateLastPage | 是 | Integer | 导航条上的最后一页 | 8 | |
nextPage | 是 | Integer | 下一页 | 0 | |
pageNum | 是 | Integer | 页数 | 1 | |
pageSize | 是 | Integer | 页大小 | 10 | |
pages | 是 | Integer | 页 | 1 | |
prePage | 是 | Integer | 前一页 | 0 | |
size | 是 | Integer | 大小 | 2 | |
startRow | 是 | Integer | 开始行 | 1 | |
total | 是 | Integer | 总页数 | 2 | |
list | 是 | Array of Objects | 对象数组 | T |
表T
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 参数模版id | 1 | |
userId | 是 | Integer | 用户id | 1 | |
parameterGroupName | 是 | String | Default-5.7 | Default-5.7 | |
mysqlEngine | 是 | String | 引擎 | 5.7 | |
createTime | 是 | String | 创建时间 | 2022-08-02 11:11:11 | |
description | 是 | String | 描述 | 5.7的默认 | |
isDefault | 是 | String | 属否是默认参数组 | 1 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"navigatepageNums": [1],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 3,
"pageSize": 10,
"list": [{
"parameterGroupName": "Default-MySQL-8.0",
"mysqlEngine": "8.0",
"createTime": 1675657467000,
"description": "Default for 8.0",
"id": 18,
"isdefault": 1,
"userId": 3304
}, {
"parameterGroupName": "paramsGroup-TtOe",
"mysqlEngine": "8.0",
"createTime": 1679649281000,
"description": "paramsGroup-TtOe",
"id": 22,
"isdefault": 0,
"userId": 3304
}, {
"parameterGroupName": "testpatten",
"mysqlEngine": "8.0",
"createTime": 1681886916000,
"description": "test",
"id": 28,
"isdefault": 0,
"userId": 3304
}],
"pageNum": 1,
"navigatePages": 8,
"navigateFirstPage": 1,
"total": 3,
"pages": 1,
"size": 3,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败, 失败原因见message |