接口功能介绍
调用modifyParameter接口修改MongoDB实例的参数。
接口约束
无
URI
POST /v1/openApi/modifyParameter
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 实例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 60d420bffb394397b4303be871a481e3 | |
| parameters | 是 | Object[] | 参数数组 | parameters |
表parameters
| 参数 | 是否必填 | 参数类型 | 说明 | 实例 | 下级对象 |
|---|---|---|---|---|---|
| parameterName | 是 | String | 参数名 | ||
| parameterValue | 是 | String | 修改后的参数值 | ||
| oldValue | 是 | String | 参数的旧值 | ||
| restart | 是 | String | 是否需要重启，0不重启，1重启 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回码 取值范围：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object | 返回对象 | returnObj |
请求示例
请求体body
{
"prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
"parameters":
[{
"parameterName":"cursorTimeoutMillis",
"parameterValue":"800000",
"oldValue":"600000",
"restart":"0"
}]
}
响应示例
{
"statusCode": 800,
"message": "修改参数组成功",
"returnObj": null
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 请求响应失败，失败原因见message |
错误码
无
