修改MongoDB實例的參數
更新時間 2023-08-29 15:13:53
最近更新時間: 2023-08-29 15:13:53
分享文章
接口功能介紹
調用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 |
錯誤碼
無
