143 lines
3.1 KiB
Markdown
143 lines
3.1 KiB
Markdown
|
# 接口文档：获取数据批次详细信息
|
|||
|
|
|
|||
|
|
## 接口信息
|
|||
|
|
|
|||
|
|
- **接口名称**: 获取数据批次详细信息
|
|||
|
|
- **接口路径**: /integration/batch/{id}
|
|||
|
|
- **请求方法**: GET
|
|||
|
|
- **模块归属**: 数据批次管理
|
|||
|
|
- **版本号**: v1.0
|
|||
|
|
- **创建日期**: 2026-01-09
|
|||
|
|
- **最后更新**: 2026-01-09
|
|||
|
|
|
|||
|
|
## 功能描述
|
|||
|
|
|
|||
|
|
根据批次ID获取数据批次的详细信息，包括批次基本信息、同步状态、数据量等。
|
|||
|
|
|
|||
|
|
## 请求参数
|
|||
|
|
|
|||
|
|
### 路径参数
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|
|||
|
|
|--------|------|------|------|------|
|
|||
|
|
| id | Integer | 是 | 批次ID | 1 |
|
|||
|
|
|
|||
|
|
## 响应数据
|
|||
|
|
|
|||
|
|
### 成功响应
|
|||
|
|
|
|||
|
|
**HTTP 状态码**: 200 OK
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"message": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"id": 1,
|
|||
|
|
"api": "Account",
|
|||
|
|
"label": "账户",
|
|||
|
|
"syncType": "FULL",
|
|||
|
|
"syncStatus": true,
|
|||
|
|
"sfNum": 1000,
|
|||
|
|
"dbNum": 1000,
|
|||
|
|
"firstSyncTime": "2025-12-24T10:00:00",
|
|||
|
|
"lastSyncTime": "2025-12-24T10:30:00",
|
|||
|
|
"createBy": "admin",
|
|||
|
|
"createTime": "2025-12-24T09:00:00",
|
|||
|
|
"updateBy": "admin",
|
|||
|
|
"updateTime": "2025-12-24T10:30:00"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 失败响应
|
|||
|
|
|
|||
|
|
**HTTP 状态码**: 400/401/404/500
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 404,
|
|||
|
|
"message": "批次不存在",
|
|||
|
|
"data": null
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 接口示例
|
|||
|
|
|
|||
|
|
### 请求示例
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
curl -X GET "http://localhost:8080/integration/batch/1" \
|
|||
|
|
-H "Authorization: Bearer [token]"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 响应示例
|
|||
|
|
|
|||
|
|
**成功**:
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"message": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"id": 1,
|
|||
|
|
"api": "Account",
|
|||
|
|
"label": "账户",
|
|||
|
|
"syncType": "FULL",
|
|||
|
|
"syncStatus": true,
|
|||
|
|
"sfNum": 1000,
|
|||
|
|
"dbNum": 1000,
|
|||
|
|
"firstSyncTime": "2025-12-24T10:00:00",
|
|||
|
|
"lastSyncTime": "2025-12-24T10:30:00",
|
|||
|
|
"createBy": "admin",
|
|||
|
|
"createTime": "2025-12-24T09:00:00",
|
|||
|
|
"updateBy": "admin",
|
|||
|
|
"updateTime": "2025-12-24T10:30:00"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**失败**:
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 404,
|
|||
|
|
"message": "批次不存在",
|
|||
|
|
"data": null
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误处理
|
|||
|
|
|
|||
|
|
- **401 未授权**: 用户没有访问权限
|
|||
|
|
- **404 未找到**: 批次不存在
|
|||
|
|
- **500 服务器错误**: 服务器内部错误，可能是数据库连接失败等
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
- 接口需要 `integration:batch:query` 权限
|
|||
|
|
- 批次ID必须为整数类型
|
|||
|
|
|
|||
|
|
## 相关接口
|
|||
|
|
|
|||
|
|
- [查询数据批次列表](http://localhost:8080/integration/batch/list) - 查询数据批次列表
|
|||
|
|
- [修改数据批次](http://localhost:8080/integration/batch) - 修改数据批次
|
|||
|
|
|
|||
|
|
## 实现细节
|
|||
|
|
|
|||
|
|
- 接口通过调用 `dataiIntegrationBatchService.selectDataiIntegrationBatchById()` 方法获取数据
|
|||
|
|
- 返回数据经过 VO 转换，确保数据结构清晰
|
|||
|
|
|
|||
|
|
## 测试信息
|
|||
|
|
|
|||
|
|
### 测试环境
|
|||
|
|
|
|||
|
|
- **环境**: 开发环境
|
|||
|
|
- **版本**: v1.0
|
|||
|
|
|
|||
|
|
### 测试用例
|
|||
|
|
|
|||
|
|
| 测试场景 | 输入参数 | 预期结果 | 实际结果 | 状态 |
|
|||
|
|
|----------|----------|----------|----------|------|
|
|||
|
|
| 获取存在批次的详细信息 | id=1（存在） | 操作成功，返回批次详细信息 | 操作成功，返回批次详细信息 | 通过 |
|
|||
|
|
| 获取不存在批次的详细信息 | id=999（不存在） | 操作失败，返回错误信息 | 操作失败，返回错误信息 | 通过 |
|