查询实例当前参数配置
更新时间 2025-09-19 14:43:02
最近更新时间: 2025-09-19 14:43:02
接口功能介绍
查询实例当前参数配置
接口约束
无
URI
GET /RDS2/v1/open-api/parameter/describe-parameters
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例Id | 1 | |
| pageNow | 否 | Integer | 当前页 | 1 | |
| pageSize | 否 | Integer | 页大小 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 是 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 是 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功; 2001 参数异常；3001 业务异常；5001 请求响应失败 | 0 | |
| returnObj | Object | 返回对象 | returnObj | |
| message | String | 结果信息 | success | |
| 表 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 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| parameterGroupName | String | 参数模版名字 | test | |
| valuetype | String | 类型 | int | |
| restart | String | 是否需要重启 | 1 | |
| description | String | 描述 | auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。 | |
| prodInstId | Integer | 实例id | 1 | |
| id | Integer | id | 309 | |
| parameterName | String | 参数名 | back_log | |
| parameterValue | String | 参数值 | 650 | |
| permitValue | String | 参数取值范围 | 1~100,000 | |
| userId | Integer | 用户id | 1 |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/parameter/describe-parameters?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{"statusCode": 0,"message": "success","returnObj": {"lastPage": 8,"navigatepageNums": [1, 2, 3, 4, 5, 6, 7, 8],"startRow": 1,"hasNextPage": true,"prePage": 0,"nextPage": 2,"endRow": 10,"pageSize": 10,"list": [{"parameterGroupName": "Default-MySQL-5.7","valuetype": "int","restart": "0","description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。","prodInstId": 47,"id": 1,"parameterName": "auto_increment_increment","parameterValue": "1","permitValue": "1~65,535","userId": 1}],"pageNum": 1,"navigatePages": 8,"total": 180,"pages": 18,"firstPage": 1,"size": 10,"isLastPage": false,"hasPreviousPage": false,"isFirstPage": true}}
状态码
请参考 状态码
错误码
请参考 错误码
