接口功能介绍
调用describeParameters接口查询实例的参数配置信息。
接口约束
无
URI
GET /v1/openApi/describeParameters
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | 555b89493b1a40e1b97ea05e50dd8170 | |
| pageNow | 否 | Integer | 当前页 | 1 | |
| pageSize | 否 | Integer | 每页数量 | 1 | |
| parameterName | 否 | String | 参数名称 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回码 取值范围：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表retunObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| userId | 是 | String | 用户id | ||
| isdefault | 是 | String | 参数是否可以修改 | ||
| parameterGroupName | 是 | String | 参数组名称 | ||
| parameterValue | 是 | String | 参数值 | ||
| parameterName | 是 | String | 参数名 | ||
| permitValue | 是 | string | 参数允许范围 | ||
| valuetype | 是 | String | 参数数据类型 | ||
| restart | 是 | String | 参数是否重启才能生效 | ||
| description | 是 | String | 参数描述 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeParameters?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"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
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 请求响应失败，失败原因见message |
错误码
无
