Query the Slow Query Log of an Instance
API Introduction
Call describeSlowLogRecords to query the log details of slow operations that occur when the MongoDB instance is running.
API Restrictions
None
URI
GET /v1/openApi/describeSlowLogRecords
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | *Required | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
pageNow | Optional | Integer | Current page | 1 |
pageSize | Optional | Integer | Number per page | 10 |
node | Optional | String | Instance node information | |
slowType | Optional | String | Slow statement type | |
beginTime | Optional | String | Start Time | 10/10/2022 12:00:00 AM |
endTime | Optional | String | End Time | 10/10/2022 12:00:00 AM |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
pageNum | Yes | Integer | Current page | 1 | |
pageSize | Yes | Integer | Number per page | 10 | |
total | Yes | Integer | Total number of queries | 100 | |
list | Yes | object[] | Query result body | list |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
exeStatement | Yes | String | |||
node | Yes | String | The label of mongodb is specified as "set_ + three tail ip + port number" | set_1098350_1 | |
databaseBelong | Yes | String | Owning database | mongodb | |
exeStartTime | Yes | String | Execution start time | 10/10/2022 12:00:00 AM | |
statementType | Yes | String | Slow statement type | command | |
avgScanDocNum | Yes | Integer | Number of document scans | 1 | |
avgWaitLockTime | Yes | Integer | Lock waiting time | 1 | |
avgReturnDocNum | Yes | Integer | Number of documents returned | 1 | |
avgExeTime | Yes | Integer | Statement execution time | 1 |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeSlowLogRecords?prodInstId=a649077e15f349cb8b4cde6f7285a568&pageNow=1&pageSize=10
Response Example
{
"statusCode": 800,
"message": "the details on slow operation log during instance running are queried successfully",
"returnObj": {
"pageSize": 10,
"list": [
{
"exeStatement": "insert into mongodb",
"node": "set_1098350_1",
"databaseBelong": "mongodb",
"exeStartTime": 1658910120000,
"statementType": "command",
"avgScanDocNum": 100,
"avgWaitLockTime": 20,
"avgReturnDocNum": 6,
"avgExeTime": 100
}
],
"pageNum": 1,
"total": 1
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None
Query the User Action Log
API Introduction
Call describeOperationRecords to query user operation log.
API Restrictions
None
URI
GET /v1/openApi/describeOperationRecords
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
pageNow | Optional | Integer | Current page | 1 |
pageSize | Optional | Integer | Number per page | 10 |
beginTime | Optional | String | Start Time | 10/10/2022 12:00:00 AM |
endTime | Optional | String | End Time | 10/10/2022 12:00:00 AM |
result | Optional | String | Operation Result | |
operateType | Optional | String | Operation Type |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
pageNum | Yes | Integer | Current page | 1 | |
pageSize | Yes | Integer | Number per page | 10 | |
total | Yes | Integer | Total number of queries | 100 | |
list | Yes | object[] | Query result body | list |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
createTime | Yes | String | Created At | 10/10/2022 12:00:00 AM | |
operateType | Yes | Integer | Operation Type 0 -> Others 1 -> Reset Password 2 -> Restart 3 -> Backup 4 -> Restore 5 -> Modify Backup Policy 6 -> Modify Parameter 7 -> Reset Parameter 8 -> Delete Backup 9 -> Modify Global Alarm Configuration | 0 | |
responseData | Yes | String | Operation Result | success | |
requestData | Yes | String | url request data content | [{"prodInstId":"c46d8f547cc648a78a68270092e70f80"}] | |
userId | Yes | Interge | User id | 149 | |
id | Yes | Integer | 1 | ||
url | Yes | Integer | url request address | http://localhost:9000/mongo-ctyun-dev/openApi/describeParameterModificationHistory | |
username | Yes | Integer | User Name | admin |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeOperationRecords?pageNow=1&pageSize=10&result=success&operateType=6
Response Example
{
"statusCode": 800,
"message": "the details on user operation log are queried successfully",
"returnObj": {
"pageSize": 3,
"list": [
{
"createTime": 1658911941000,
"operateType": 0,
"responseData": "success",
"requestData": "[{\"prodInstId\":\"c46d8f547cc648a78a68270092e70f80\"}]",
"userId": 149,
"url": "http://localhost:9000/mongo-ctyun-dev/openApi/describeParameterModificationHistory",
"username": "yxp"
},
{
"createTime": 1658906785000,
"operateType": 6,
"responseData": "SUCCESS",
"requestData": "[{prodInstId=c46d8f547cc648a78a68270092e70f80, parameters=[{parameterName=wiredTigerConcurrentReadTransactions, parameterValue=128, oldValue=127, restart=0}, {parameterName=wiredTigerConcurrentWriteTransactions, parameterValue=128, oldValue=127, restart=0}]}]",
"userId": 149,
"url": "http://172.27.176.109:9000/mongo-standalone//v1/ddsConsole/parameterGroup-manage/modifyParameters",
"username": "yxp"
},
{
"createTime": 1658906758000,
"operateType": 6,
"responseData": "SUCCESS",
"requestData": "[{prodInstId=c46d8f547cc648a78a68270092e70f80, parameters=[{parameterName=wiredTigerConcurrentReadTransactions, parameterValue=127, oldValue=128, restart=0}, {parameterName=wiredTigerConcurrentWriteTransactions, parameterValue=127, oldValue=128, restart=0}]}]",
"userId": 149,
"url": "http://172.27.176.109:9000/mongo-standalone//v1/ddsConsole/parameterGroup-manage/modifyParameters",
"username": "yxp"
}
],
"pageNum": 1,
"total": 14
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None
Query the Error Log of an Instance
API Introduction
Call describeErrorLogRecords to query the error log of MongoDB instance.
API Restrictions
None
URI
GET /v1/openApi/describeErrorLogRecords
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | *Required | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
pageNow | Optional | Integer | Current page | 1 |
pageSize | Optional | Integer | Number per page | 10 |
node | Optional | String | Instance node information | |
level | Optional | String | Error level | error |
beginTime | Optional | String | Start Time | 10/10/2022 12:00:00 AM |
endTime | Optional | String | End Time | 10/10/2022 12:00:00 AM |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
pageNum | Yes | Integer | Current page | 1 | |
pageSize | Yes | Integer | Number per page | 10 | |
total | Yes | Integer | Total number of queries | 100 | |
list | Yes | object[] | Query result body | list |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
createTime | Yes | String | 10/10/2022 12:00:00 AM | ||
node | Yes | String | The label of mongodb is specified as "set_ + three tail ip + port number" | set_1098350_1 | |
level | Yes | String | Alarm level | error | |
port | Yes | String | Port accessed by mongodb | 8888 | |
host | Yes | String | Machine ip accessed by mongodb | 127.0.0.1 | |
id | Yes | Integer | Number of document scans | 1 | |
lineNumber | Yes | Integer | In the actual error log, the line number corresponding to this record | 1 | |
message | Yes | Integer | Error log details | Warning:better encrypted passwor | |
resId | Yes | Integer | Uniquely identifies mongodb | 67 |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeErrorLogRecords?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message":"the error log of the MongoDB instance is queried successfully",
"returnObj": {
"pageSize": 10,
"list": [
{
"node": "set_1098350_1",
"createTime": 1658909280000,
"level": "Warning",
"port": "8350",
"host": "172.27.176.109",
"id": 1,
"lineNumber": null,
"message": "Warning:better encrypted password",
"resId": 67
}
],
"pageNum": 1,
"total": 1
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None