接口说明
调用pageQuery接口分页查询投递任务列表
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/query HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
orderCode | String | query | 否 | DESC | 排序规则【DESC或ASC】,默认为DESC |
resPoolCode | String | query | 是 | d8bbd132b53a11e9b0e40242 | 资源池编码 |
originProjectId | Long | query | 是 | 228 | 源日志项目ID |
originUnitId | Long | query | 是 | 1501 | 源日志单元ID |
teskId | String | query | 否 | 108 | 投递任务ID |
taskName | String | query | 否 | test-taskName | 任务名称 |
status | String | query | 否 | 2 | 任务状态:1-启动中;2-运行中;3-成功;4-失败;5-停止中;6-已终止 |
processRange | String | query | 否 | 1 | 投递范围:1-所有;2-某时间开始【默认选中】;3-特定时间范围 |
startTime | Long | query | 否 | 1532568598 | 投递开始时间,单位毫秒 |
endTime | Long | query | 否 | 1532568598 | 投递结束时间,单位毫秒 |
instanceType | Integer | query | 否 | 1 | 投递实例类型:1-Kafka;2-对象存储 |
pageNum | Integer | query | 否 | 1 | 页码 |
pageSize | Integer | query | 否 | 10 | 每页记录数 |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码 |
data | Object | 查询投递任务结果数据,详细见下表 | |
msg | String | "" | 返回信息 |
data 数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
statisticsDTO | Object | 任务汇总状态,详情见下表 | |
tasks | Object | 投递任务详情,详情见下表 |
statisticsDTO数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
running | Long | 5 | 状态为running的任务个数 |
success | Long | 10 | 状态为success的任务个数 |
fail | Long | 2 | 状态为fail的任务个数 |
tasks中列表元素数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
taskId | String | 108 | 任务ID |
taskName | String | test-taskName | 任务名称 |
originProjectId | Long | 228 | 源日志项目ID |
originUnitId | Long | 1501 | 源日志单元ID |
status | String | 1 | 任务状态:1-启动中;2-运行中;3-成功;4-失败;5-停止中;6-已终止 |
instanceConfig | Json | 投递实例配置,根据不同的instanceType有不同的配置 | |
instanceType | Interger | 1 | 投递实例类型:1-Kafka;2-对象存储 |
createTime | Long | 1532548598 | 投递任务创建时间,单位毫秒 |
createUser | String | test-creatUser | 创建人 |
updateTime | Long | 1532568598 | 更新时间,单位毫秒 |
updateUser | String | test-updateUser | 更新人 |
resPoolCode | String | d8bbd132b53a11e9b0e40242 | 资源池编码 |
tenantId | String | 3405 | 租户ID |
示例
请求示例
GET /paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/query?originProjectId=228&originUnitId=1501&resPoolCode=bbd132b53a11e9b0e40242ac11000&pageNum=1&pageSize=10 HTTP/1.1
正常返回示例
{
"code": 0,
"data": {
"statisticsDTO": {
"fail": 2,
"running": 5,
"success": 10
},
"tasks": {
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"createTime": 1532548598,
"createUser": "test-creatUser",
"endTime": 1532568598,
"instanceConfig": {
"instance": "1.1.1.1:1001",
"topic": "jason2023070305",
"username":"root",
"password":"U2FsdGVkX18JgZKhKY2Yn2A84"
},
"instanceType": 1,
"message": "",
"originProjectId": 228,
"originProjectName": "test-originProjectName",
"originUnitId": 1501,
"originUnitName": "test-originUnitName",
"processRange": "3",
"resPoolCode": "d8bbd132b53a11e9b0e40242",
"startTime": 1532549598,
"status": "1",
"taskId": "108",
"taskName": "test-taskName",
"tenantId": "3405",
"updateTime": 1532549598,
"updateUser": "test-updateUser"
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [
0
],
"nextPage": 1,
"pageNum": 1,
"pageSize": 10,
"pages": 2,
"prePage": 3,
"size": 0,
"startRow": 0,
"total": 100
}
},
"msg": ""
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
400 | InvalidParameterValue | 请求参数取值错误。 |
400 | InvalidTimeRanger | 查询时间范围异常 |
500 | FailedOperation | 操作失败 |