API Introduction
Call the describeParameterModificationHistory API to query the modification records of MongoDB instance parameters.
API Restrictions
None
URI
GET /v1/openApi/describeParameterModificationHistory
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstId | Yes | String | Instance ID. | 555b89493b1a40e1b97ea05e50dd8170 | |
pageNow | No | Integer | Current page | 1 | |
pageSize | No | Integer | Number per page | 1 | |
parameterName | No | String | Parameters to be searched | Instance | |
beginTime | No | String | Start Time | ||
endTime | No | String | End Time |
Request Parameters
Request Header Parameter
None
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 array | returnObj |
Table retunObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
createTime | Yes | Integer | Created At | ||
parameterOldValue | Yes | String | Old Value | ||
isvalid | Yes | String | Whether the modification takes effect | ||
prodInstId | Yes | String | Instance ID. | ||
parameterName | Yes | String | Parameter name | ||
userId | Yes | string | User id | ||
parameterNewValue | Yes | String | Modified value |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeParameterModificationHistory?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message": "the modification records of MongoDB instance parameters are queried successfully",
"returnObj": {
"lastPage": 1,
"navigatepageNums": [
1
],
"startRow": 1,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 2,
"pageSize": 10,
"list": [
{
"createTime": 1658912096000,
"parameterOldValue": "128",
"isvalid": "0",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"id": 2,
"parameterName": "wiredTigerConcurrentWriteTransactions",
"userId": 149,
"parameterNewValue": "127"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 2,
"pages": 1,
"firstPage": 1,
"size": 2,
"isLastPage": true,
"hasPreviousPage": false,
"isFirstPage": true
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None