API Introduction
Call the modifyParameter API to modify the parameters of MongoDB instance.
API Restrictions
None
URI
POST /v1/openApi/modifyParameter
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Request Body Parameter
Parameter | Required or Not | Parameter Type | Description | Instance | Lower-level Object |
prodInstId | Yes | String | Instance ID | 60d420bffb394397b4303be871a481e3 | |
parameters | Yes | Object[] | Parameter array | parameters |
Table parameters
Parameter | Required or Not | Parameter Type | Description | Instance | Lower-level Object |
parameterName | Yes | String | Parameter name | ||
parameterValue | Yes | String | Modified parameter value | ||
oldValue | Yes | String | Old value of the parameter | ||
restart | Yes | String | Whether to restart, 0 means not restart, 1 means restart |
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | String | Return code Value range: 800 indicates success | 800 | |
message | Yes | String | Return to Messages | ||
returnObj | Yes | Object | Return object. | returnObj |
Sample Request
Request Body
{
"prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
"parameters":
[{
"parameterName":"cursorTimeoutMillis",
"parameterValue":"800000",
"oldValue":"600000",
"restart":"0"
}]
}Response Example
{
"statusCode": 800,
"message": "the parameter group is modified successfully",
"returnObj": null
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None