分页查询指定元数据采集器的运行记录,并可按时间范围和运行状态筛选。
接口说明
使用场景
分页查询指定元数据采集器最近 30 天内的运行记录,并可按运行开始时间和状态筛选。
推荐流程
使用
ListCrawlers查询采集器 ID。调用本接口查询运行记录和任务实例 ID。
对运行、停止等异步操作,以本接口返回的最终状态为准。
版本要求
需要购买 DataWorks 基础版及以上版本才能使用。
注意事项
未指定时间范围时,默认查询当前时间向前 30 天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
integer |
是 |
元数据采集器 ID。您可以通过 ListCrawlers 查询。 |
1234 |
| StartTimeFrom |
integer |
否 |
运行开始时间下界,毫秒级 Unix 时间戳。取值必须位于最近 30 天内;未传入时默认为当前时间前 30 天。 |
1710239005403 |
| StartTimeTo |
integer |
否 |
运行开始时间上界,毫秒级 Unix 时间戳。取值必须位于最近 30 天内;未传入时默认为当前时间。 |
1710325405403 |
| Status |
string |
否 |
运行状态。取值:WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。 |
SUCCESS |
| PageNumber |
integer |
否 |
分页页码,从 1 开始,默认值为 1。 |
1 |
| PageSize |
integer |
否 |
每页条目数,默认值为 20,最大值为 100。 |
20 |
StartTimeFrom 和 StartTimeTo 使用毫秒级 Unix 时间戳,必须位于最近 30 天内,且 StartTimeFrom 不能晚于 StartTimeTo。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。用于定位日志,排查问题。 |
9252F32F-D855-549E-8898-61CF5A733050 |
| Success |
boolean |
请求是否成功。 |
|
| PagingInfo |
object |
分页信息。 |
|
| TotalCount |
integer |
符合查询条件的记录总数。 |
1 |
| PageNumber |
integer |
当前页码。 |
1 |
| PageSize |
integer |
每页条目数。 |
20 |
| CrawlerRuns |
array<object> |
元数据采集器运行记录列表。 |
|
|
object |
单次元数据采集器运行记录。 |
||
| Status |
string |
运行状态。取值:WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN |
SUCCESS |
| TaskInstanceId |
integer |
本次运行关联的 DataWorks 任务实例 ID。 |
1234 |
| StartedTime |
integer |
开始时间,毫秒级 Unix 时间戳 |
1710239005403 |
| FinishedTime |
integer |
结束时间,毫秒级 Unix 时间戳 |
1710239065403 |
| Duration |
number |
运行耗时,单位为秒 |
60 |
| TotalTableCount |
integer |
本次运行涉及的表总数 |
42 |
CrawlerRuns 返回当前页运行记录;可以使用 TaskInstanceId 关联一次运行。
示例
正常返回示例
JSON格式
{
"RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
"Success": true,
"PagingInfo": {
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 20,
"CrawlerRuns": [
{
"Status": "SUCCESS",
"TaskInstanceId": 1234,
"StartedTime": 1710239005403,
"FinishedTime": 1710239065403,
"Duration": 60,
"TotalTableCount": 42
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。