获取参数模板列表
更新时间 2025-09-19 14:42:39
最近更新时间: 2025-09-19 14:42:39
接口功能介绍
获取参数模板列表信息
接口约束
无
URI
GET /RDS2/v1/open-api/parameter/parameter-groups
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| parameterGroupName | 否 | String | 模板名称 | Default-5.7 | |
| engineVersion | 否 | String | 引擎版本 | 5.7 | |
| pageNow | 否 | Integer | 当前页 | 1 | |
| pageSize | 否 | Integer | 页大小 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| regionId | 是 | String | 资源区regionId，比如实例在资源区A，则需要填写A资源区的regionId | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功; 2001 参数异常；3001 业务异常；5001 请求响应失败 | 0 | |
| returnObj | Object | 返回对象 | returnObj | |
| message | String | 结果信息 | success | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endRow | Integer | 终行 | 2 | |
| firstPage | Integer | 第一页 | 1 | |
| hasNextPage | Boolean | 是否有后一页 | false | |
| hasPreviousPage | Boolean | 是否有前一页 | false | |
| isFirstPage | Boolean | 是否第一页 | true | |
| isLastPage | Boolean | 是否最后一页 | true | |
| lastPage | Integer | 最后一页 | 1 | |
| navigatepageNums | Array of Integers | 页码 | [1] | 1 |
| 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 | 对象数组 | Object | |
| 表 Object |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 参数模版id | 1 | |
| userId | Integer | 用户id | 1 | |
| parameterGroupName | String | 参数组名称 | Default-5.7 | |
| mysqlEngine | String | 引擎 | 5.7 | |
| createTime | String | 创建时间 | 2022-08-02 11:11:11 | |
| description | String | 描述 | 5.7的默认 | |
| isdefault | String | 属否是默认参数组 | 1 | |
| restart | Boolean | 修改该参数是否需要重启 | false |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/parameter/parameter-groups
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"endRow":2,
"firstPage":1,
"hasNextPage": false,
"hasPreviousPage": false,
"isFirstPage": true,
"isLastPage": true,
"lastPage": 1,
"list": [{"id": 1,
"userId": 1,
"parameterGroupName": "Default-5.7",
"mysqlEngine":"5.7",
"createTime":"2022-08-02 11:11:11",
"description":"",
"restart":false,
"isDefault":"0"}
],
"navigatepageNums": [1],
"nextPage": 0,
"pageNum": 1,
"pageSize":10,
"pages":1,
"prePage": 0,
"size": 2,
"startRow":1,
"total": 2
}
}
状态码
请参考 状态码
错误码
请参考 错误码
