错误日志列表
更新时间 2025-09-24 14:48:50
最近更新时间: 2025-09-24 14:48:50
接口功能介绍
获取错误日志文件列表
接口约束
存在用户实例并拿到实例ID
URI
GET /RDS2/v1/open-api/errorlog/list-files
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 | |
pageNow | 否 | Integer | 慢查询当前页 不填默认1 1 | 1 | |
pageSize | 否 | Integer | 页面记录数 不填默认10 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
inst-id | 否 | String | 实例id (和参数outerProdInstId保持一致) | 264729201196525109 | |
regionId | 是 | String | 资源池regionId,比如实例在资源池A,则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 取值范围:0 成功 | 0 | |
message | String | 返回消息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页的数量 | 1 | |
size | Integer | 当前页的数量 | 0 | |
startRow | Integer | 当前页面第一个元素在数据库中的行号 | 0 | 1 |
endRow | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | 1 |
total | Integer | 总记录数 | 1 | |
pages | Integer | 总页数 | 1 | |
firstPage | Integer | 第一页 | 1 | |
prePage | Integer | 前一页 | 1 | |
isFirstPage | Boolean | 是否为第一页 | ||
isLastPage | Boolean | 是否为最后一页 | ||
hasPreviousPage | Boolean | 是否有前一页 | ||
hasNextPage | Boolean | 是否有下一页 | ||
navigatePages | Integer | 导航页码数 | ||
navigatepageNums | Array of Integers | 所有导航页号 | pageNum | |
nextPage | Integer | 下一页 | ||
navigateLastPage | Integer | 页面上显示的最后一个页码 | 1 | |
navigateFirstPage | Integer | 页面显示的第一个页码 | 1 | |
list | Array of Objects | 结果集(每页显示的数据) | T | |
表 T |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
logType | String | 日志类型 | error | |
targetSize | String | 目标文件大小 | 0B | |
resName | String | 资源名称 | m | |
sourceIdentifier | String | 源标识符 | 2024-11-14 17:50:25.671683283 +0800 | |
targetPath | String | 目标路径 | ||
initialized | Boolean | 是否已初始化 | true | |
prodInstId | Integer | 产品实例ID | 9308 | |
sourceSize | String | 源文件大小 | 1.89KB | |
resId | Integer | 资源ID | 427 | |
sourceFile | String | 源文件名 | slow_query_2024_11_14_17_40_01.log | |
sourcePath | String | 源文件路径 | ||
status | Integer | 状态 0:未处理(默认);1:待处理;2:处理中(清理历史文件、筛选、传输);3:处理完成;4:处理失败;5:已过期 | 0 | |
role | String | 节点类型 | m | |
taskType | String | 任务类型 | 日志生成任务类型,未发起任务时默认CONSOLE |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/errorlog/list-files?outerProdInstId=abc13cf3d9ef4576b54d95e16b68a2f7&pageNow=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"startRow": 0,
"navigatepageNums": [
1
],
"prePage": 0,
"hasNextPage": false,
"nextPage": 0,
"pageSize": 10,
"endRow": 0,
"list": [
{
"logType": "error",
"msg": "start error log zos task!get remote file size success!grep data success!rm remote tmp file success!task finish success!",
"sourceIdentifier": "2025-04-21 17:23:16.393063783 +0800",
"role": "m",
"overTime": "2025-04-21 17:43:00",
"targetPath": "",
"updateTime": "2025-04-21 17:23:04",
"resId": 534,
"sourceFile": "error.log",
"taskType": "ZOS",
"targetSize": "330.08KB",
"readyTime": "2025-04-21 17:23:04",
"resName": "m534",
"expireTime": "2025-04-21 17:53:04",
"createTime": "2025-04-21 17:22:49",
"targetFile": "tmp_error_ZOS_9438_534_20250421172249000704.log",
"initialized": true,
"prodInstId": 9438,
"id": 8,
"sourceSize": "609.63KB",
"taskId": "log_task_error_ZOS_9438_534_20250421172249000704",
"sourcePath": "",
"status": 3
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 1,
"navigateFirstPage": 1,
"pages": 1,
"size": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
},
"statusCode": 0,
"message": "success"
}
状态码
请参考 状态码
错误码
请参考 错误码