日志管理

2025-06-27 02:35:46

查询实例慢操作日志

接口功能介绍

调用describeSlowLogRecords查询MongoDB实例运行出现的慢操作日志明细。

接口约束

无

URI

GET  /v1/openApi/describeSlowLogRecords

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例
prodInstId	*必填	String	文档数据库对外的实例标识	a649077e15f349cb8b4cde6f7285a568
pageNow	非必填	Integer	当前页	1
pageSize	非必填	Integer	每页数量	10
node	非必填	String	实例节点信息
slowType	非必填	String	慢语句类型
beginTime	非必填	String	开始时间	2022-10-10 00:00:00
endTime	非必填	String	结束时间	2022-10-10 00:00:00

请求参数

请求头header参数

无

响应参数

参数	是否必填	参数类型	说明		下级对象
statusCode	是	Integer	响应码取值范围：800为成功，900为失败	800
message	是	String	响应信息	查询XXX信息成功
returnObj	是	Object	返回对象		returnObj

表returnObj

参数	是否必填	参数类型	说明	示例	下级对象
pageNum	是	Integer	当前页	1
pageSize	是	Integer	每页数量	10
total	是	Integer	查询总数	100
list	是	object[]	查询结果主体		list

表list

参数	是否必填	参数类型	说明	示例	下级对象
exeStatement	是	String
node	是	String	该mongodb的标签，规定为“set_ + 三个尾部ip + 端口号”	set_1098350_1
databaseBelong	是	String	所属数据库	mongodb
exeStartTime	是	String	执行开始时间	2022-10-10 00:00:00
statementType	是	String	慢语句类型	command
avgScanDocNum	是	Integer	文档扫描数	1
avgWaitLockTime	是	Integer	锁等待时间	1
avgReturnDocNum	是	Integer	文档返回数	1
avgExeTime	是	Integer	语句执行时间	1

请求示例

请求头header

无

请求参数query

/v1/openApi/describeSlowLogRecords?prodInstId=a649077e15f349cb8b4cde6f7285a568&pageNow=1&pageSize=10

响应示例

响应示例
{
    "statusCode": 800,
    "message": "查询实例运行出现的慢操作日志明细成功",
    "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
    }
}

状态码

状态码	描述
800	表示请求成功
900	表示请求失败

错误码

无

查询用户操作日志

接口功能介绍

调用describeOperationRecords查询用户操作日志。

接口约束

无

URI

GET  /v1/openApi/describeOperationRecords

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例
pageNow	非必填	Integer	当前页	1
pageSize	非必填	Integer	每页数量	10
beginTime	非必填	String	开始时间	2022-10-10 00:00:00
endTime	非必填	String	结束时间	2022-10-10 00:00:00
result	非必填	String	操作结果
operateType	非必填	String	操作类型

请求参数

请求头header参数

无

响应参数

参数	是否必填	参数类型	说明		下级对象
statusCode	是	Integer	响应码取值范围：800为成功，900为失败	800
message	是	String	响应信息	查询XXX信息成功
returnObj	是	Object	返回对象		returnObj

表returnObj

参数	是否必填	参数类型	说明	示例	下级对象
pageNum	是	Integer	当前页	1
pageSize	是	Integer	每页数量	10
total	是	Integer	查询总数	100
list	是	object[]	查询结果主体		list

表list

参数	是否必填	参数类型	说明	示例	下级对象
createTime	是	String	创建时间	2022-10-10 00:00:00
operateType	是	Integer	操作类型 0 -> 其他 1 -> 重置密码 2 -> 重启 3 -> 备份 4 -> 恢复 5 -> 修改备份策略 6 -> 修改参数 7 -> 重置参数 8 -> 删除备份 9 -> 修改全局告警配置	0
responseData	是	String	操作结果	success
requestData	是	String	url请求数据内容	[{"prodInstId":"c46d8f547cc648a78a68270092e70f80"}]
userId	是	Interge	用户id	149
id	是	Integer	1
url	是	Integer	url请求地址	http://localhost:9000/mongo-ctyun-dev/openApi/describeParameterModificationHistory
username	是	Integer	用户名称	admin

请求示例

请求头header

无

请求参数query

/v1/openApi/describeOperationRecords?pageNow=1&pageSize=10&result=success&operateType=6

响应示例

{
    "statusCode": 800,
    "message": "查询用户的操作日志明细成功",
    "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
    }
}

状态码

状态码	描述
800	表示请求成功
900	表示请求失败

错误码

无

查询实例错误日志

接口功能介绍

调用describeErrorLogRecords查询MongoDB实例的错误日志。

接口约束

无

URI

GET  /v1/openApi/describeErrorLogRecords

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例
prodInstId	*必填	String	文档数据库对外的实例标识	a649077e15f349cb8b4cde6f7285a568
pageNow	非必填	Integer	当前页	1
pageSize	非必填	Integer	每页数量	10
node	非必填	String	实例节点信息
level	非必填	String	错误级别	error
beginTime	非必填	String	开始时间	2022-10-10 00:00:00
endTime	非必填	String	结束时间	2022-10-10 00:00:00

请求参数

请求头header参数

无

响应参数

参数	是否必填	参数类型	说明		下级对象
statusCode	是	Integer	响应码取值范围：800为成功，900为失败	800
message	是	String	响应信息	查询XXX信息成功
returnObj	是	Object	返回对象		returnObj

表returnObj

参数	是否必填	参数类型	说明	示例	下级对象
pageNum	是	Integer	当前页	1
pageSize	是	Integer	每页数量	10
total	是	Integer	查询总数	100
list	是	object[]	查询结果主体		list

表list

参数	是否必填	参数类型	说明	示例	下级对象
createTime	是	String		2022-10-10 00:00:00
node	是	String	该mongodb的标签，规定为“set_ + 三个尾部ip + 端口号”	set_1098350_1
level	是	String	告警级别	error
port	是	String	mongodb访问的端口	8888
host	是	String	mongodb访问的机器ip	127.0.0.1
id	是	Integer	文档扫描数	1
lineNumber	是	Integer	在实际的错误日志中，该条记录所对应的行号	1
message	是	Integer	错误日志详情	Warning:better encrypted passwor
resId	是	Integer	唯一标识mongodb	67

请求示例

请求头header

无

请求参数query

/v1/openApi/describeErrorLogRecords?prodInstId=a649077e15f349cb8b4cde6f7285a568

响应示例

{
    "statusCode": 800,
    "message": "查询MongoDB实例的错误日志成功",
    "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
    }
}

状态码

状态码	描述
800	表示请求成功
900	表示请求失败

错误码

无

文档数据库服务

日志管理

查询实例慢操作日志

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

查询用户操作日志

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

查询实例错误日志

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码