API名称:openQcTaskReport/addTaskReports,用于生成MySQL数据库文档。
openQcTaskReport/addTaskReports API 文档
openQcTaskReport/addTaskReports API 用于向数据库中添加任务报告,该API接收一系列任务报告数据,并将其存储在MySQL数据库中,每个任务报告包含任务的详细信息、执行结果和相关指标。

请求参数
以下是openQcTaskReport/addTaskReports API 所需的请求参数:
| 参数名 | 类型 | 必填 | 描述 |
| task_id | string | 是 | 任务的唯一标识符 |
| report_data | object | 是 | 包含任务报告数据的JSON对象 |
| execution_time | number | 否 | 任务执行的时间(以秒为单位) |
| status | string | 否 | 任务的状态(成功、失败、进行中) |
| metrics | object | 否 | 包含任务性能指标的JSON对象 |
示例请求
{
"task_id": "12345",
"report_data": {
"description": "This is a sample task report.",
"details": {
"step1": "Completed",
"step2": "Failed"
}
},
"execution_time": 60,
"status": "Success",
"metrics": {
"accuracy": 98.5,
"precision": 0.97
}
}
响应
成功调用openQcTaskReport/addTaskReports API 后,将返回以下响应:
| 参数名 | 类型 | 描述 |
| success | boolean | 表示操作是否成功的布尔值 |
| message | string | 描述操作结果的消息 |
| data | object | 包含已添加的任务报告的数据 |
示例响应
{
"success": true,
"message": "Task report added successfully.",
"data": {
"task_id": "12345",
"report_data": {
"description": "This is a sample task report.",
"details": {
"step1": "Completed",
"step2": "Failed"
}
},
"execution_time": 60,
"status": "Success",
"metrics": {
"accuracy": 98.5,
"precision": 0.97
}
}
}
错误处理
如果请求参数不符合要求或发生其他错误,API将返回一个包含错误信息的响应,错误响应的结构如下:
| 参数名 | 类型 | 描述 |
| success | boolean | 表示操作是否成功的布尔值 |
| message | string | 描述错误的消息 |
| error_code | number | 错误代码,用于识别特定类型的错误 |
示例错误响应
{
"success": false,
"message": "Invalid task ID.",
"error_code": 400
}
FAQs
Q: 如果任务ID已经存在于数据库中,会发生什么?
A: 如果提供的任务ID已经存在于数据库中,API将返回一个错误消息,指示任务ID无效或重复,您需要确保为每个任务提供一个唯一的ID。
Q: 如果提供的报告数据格式不正确,如何处理?
A: 如果提供的报告数据格式不正确或不符合预期的结构,API将返回一个错误消息,指示数据格式错误,请确保按照API文档中定义的格式提供正确的报告数据。