创建日志下载任务
更新时间 2025-09-24 14:48:33
最近更新时间: 2025-09-24 14:48:33
接口功能介绍
创建日志下载任务
接口约束
实例存在且存在日志文件
URI
POST /RDS2/v1/open-api/log/create-log-task
路径参数 无
Query参数 无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
inst-id | 否 | String | 实例id (和参数outerProdInstId保持一致) | 264729201196525109 | |
regionId | 是 | String | 资源池regionId,比如实例在资源池A,则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 264729201196525109 | |
resId | 是 | Integer | 节点id | 1 | |
logType | 是 | String | 日志类型 slow 慢日志 error 错误日志 | slow | |
sourceFile | 是 | String | 需要下载的文件名称 | 1 | |
taskType | 是 | String | 任务类型:ZOS | ZOS |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 取值范围:0 成功 | 0 | |
message | String | 返回消息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
logType | String | 日志类型 | slow | 无 |
taskType | String | 任务类型 | ZOS | 无 |
targetSize | String | 目标文件大小 | 2.39KB | 无 |
targetFile | String | 目标文件名 | tmp_slow_ZOS_9308_427_20241115112541000212.log | 无 |
sourceSize | String | 源文件大小 | 2.39KB | 无 |
resId | Integer | 资源 ID | 427 | 无 |
sourceFile | String | 源文件名 | slow_query_2024_11_14_17_20_01.log | 无 |
taskId | String | 任务 ID 用于下载日志接口传参 | log_task_slow_ZOS_9308_427_20241115112541000212 | 无 |
status | Integer | 状态码 0:未处理(默认);1:待处理;2:处理中(清理历史文件、筛选、传输);3:处理完成;4:处理失败;5:已过期 | 1 | 无 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"outerProdInstId": "eddf4d2c6d67407ba39e3453ee0776ca",
"resId": 427,
"logType": "slow",
"sourceFile": "slow_query_2024_11_14_17_20_01.log"
}
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"logType": "slow",
"taskType": "ZOS",
"targetSize": "2.39KB",
"targetFile": "tmp_slow_ZOS_9308_427_20241115112541000212.log",
"initialized": false,
"sourceSize": "2.39KB",
"resId": 427,
"sourceFile": "slow_query_2024_11_14_17_20_01.log",
"taskId": "log_task_slow_ZOS_9308_427_20241115112541000212",
"status": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码