接口功能介绍
调用DescribeParameterTemplates接口查询MongoDB查询默认参数模板列表。
接口约束
无
URI
GET /v1/openApi/describeParameterTemplates
请求参数
请求头header参数
无
请求体query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | 555b89493b1a40e1b97ea05e50dd8170 | |
| parameterGroupUsed | 是 | String | 参数组名，标志参数组版本 | ||
| pageNow | 否 | Integer | 当前页 | 1 | |
| pageSize | 否 | Integer | 每页数量 | 10 | |
| parameterName | 否 | String | 参数名 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回码 取值范围：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| parameterGroupName | 是 | String | 参数组名称 | ||
| valuetype | 是 | String | 参数数据类型 | ||
| restart | 是 | String | 参数是否重启才能生效 | ||
| defaultValue | 是 | String | 默认值 | ||
| groupId | 是 | String | 该参数是否允许用户修改，0表示允许 | ||
| description | 是 | String | 对参数的描述 | ||
| parameterName | 是 | String | 参数名 | ||
| parameterValue | 是 | String | 参数值 | ||
| userId | 是 | Integer | 用户id | ||
| prodInstId | 是 | String | 实例id | ||
| id | 是 | Integer | 主键 | ||
| isdefault | 是 | String | 该参数是否允许用户修改，0表示允许 | ||
| permitValue | 是 | String | 参数值允许范围 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeParameterTemplates?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例默认的参数模板列表",
"returnObj": {
"lastPage": 2,
"navigatepageNums": [
1,
2
],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 10,
"pageSize": 10,
"list": [
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "true",
"groupId": null,
"description": "????????????????????????????????",
"parameterName": "storage.directoryPerDB",
"parameterValue": "true",
"userId": 149,
"prodInstId": null,
"id": 62238,
"isdefault": "1",
"permitValue": "true,false"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 17,
"pages": 2,
"firstPage": 1,
"size": 10,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": true
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 请求响应失败，失败原因见message |
错误码
无
