查询实例参数配置信息v2
更新时间 2025-10-22 18:09:13
最近更新时间: 2025-10-22 18:09:13
接口功能介绍
查询文档数据库实例的参数配置信息
接口约束
无
URI
GET /DDS2/v2/openApi/describeParameters
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | 60d420bffb394************************* | |
| pageNow | 否 | String | 当前页，不传默认为1 | 1 | |
| pageSize | 否 | String | 每页数量，不传默认为10 | 10 | |
| parameterName | 否 | String | 参数名称 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：800 成功 | 800 | |
| message | String | 返回消息 | 接口查询MongoDB实例的参数配置信息成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| lastPage | Integer | 最后一页的页码 | 1 | |
| navigatepageNums | Array of Integers | 可用于导航的页码数组 | [1] | |
| startRow | Integer | 当前页的第一行的索引 | 1 | |
| hasNextPage | Boolean | 指示是否有下一页数据可用 | false | |
| prePage | Integer | 前一页的页码 | 0 | |
| nextPage | Integer | 下一页的页码 | 0 | |
| endRow | Integer | 当前页的最后一行的索引 | 1 | |
| pageSize | Integer | 每页包含的数据条目数量 | 10 | |
| list | Array of Objects | 查询结果主体 | list | |
| pageNum | Integer | 当前页的页码 | 1 | |
| navigatePages | Integer | 导航页数的数量 | 8 | |
| total | Integer | 总数据条目数量 | 1 | |
| pages | Integer | 总页数 | 1 | |
| firstPage | Integer | 第一页的页码 | 1 | |
| size | Integer | 当前页包含的数据条目数量 | 1 | |
| isLastPage | Boolean | 指示当前页是否是最后一页 | true | |
| hasPreviousPage | Boolean | 指示是否有前一页数据可用 | false | |
| isFirstPage | Boolean | 指示当前页是否是第一页 | true | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| parameterGroupName | String | 参数组名称 | Default-Mongo-4.0 | |
| valuetype | String | 参数数据类型 | string | |
| innerVersion | String | 小版本号 | ||
| restart | String | 参数是否重启才能生效 | 1 | |
| dbVersion | String | 大版本号 | ||
| defaultValue | String | 默认值 | true | |
| groupId | String | 该参数是否允许用户修改，0表示允许 | 0 | |
| description | String | 对参数的描述 | demo-****** | |
| parameterName | String | 参数名 | storage.directoryPerDB | |
| nodeType | String | 节点类型 | ||
| parameterValue | String | 参数值 | true | |
| userId | Integer | 用户id | 14656 | |
| tenantId | Integer | 租户id | ||
| prodInstId | String | 实例id | 60d420bffb394************************* | |
| id | Integer | 主键 | 1 | |
| isdefault | String | 该参数是否允许用户修改，0表示允许 | 0 | |
| permitValue | String | 参数值允许范围 |
枚举参数
无
请求示例
请求url
/v2/openApi/describeParameters?prodInstId=60d420bffb394*************************
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "接口查询MongoDB实例的参数配置信息成功",
"returnObj": {
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 1,
"pageSize": 10,
"list": [
{
"id": "52",
"userId": "0",
"groupId": "0",
"isdefault": "0",
"parameterGroupName": "Default-Mongo-3.4",
"parameterValue": "600",
"permitValue": "",
"parameterName": "connPoolMaxConnsPerHost",
"valuetype": "int",
"restart": "1",
"description": "表示当前实例与其他mongod实例通信的连接池的最大连接数"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 1,
"pages": 1,
"firstPage": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码
