查询任务监控信息列表
功能介绍
查询所有任务的监控信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/fdi/instances/{instance_id}/task-monitors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id |
是 |
String |
实例ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset从1开始,取0时行为与1一致。 |
limit |
否 |
Integer |
每页显示条目数量,最大数量999,超过999后只返回999。 |
task_name |
否 |
String |
需要搜索的任务名称,支持模糊搜索,大小写敏感,非必填参数,如果为空,搜索所有任务。 |
execute_status |
否 |
String |
需要搜索任务的执行状态,非必填参数,如果为空,搜索所有任务:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数。 |
size |
Integer |
当前页监控信息数量。 |
entities |
Array of TaskMonitorInfo objects |
任务监控信息当前页元素。 |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
任务ID。 |
task_name |
String |
任务名称。 |
task_type |
String |
任务类型:
|
status |
Integer |
任务状态:
|
last_execute_time |
Integer |
任务最近一次执行时间,格式timestamp(ms),使用UTC时区。 |
use_quartz_cron |
Boolean |
任务是否使用Quartz表达式,只有定时任务才有该属性。 |
cron |
String |
CRON表达式,只有定时任务且use_quartz_cron为true时才有该属性。 |
period |
String |
调度周期的单位,如天,小时等,只有定时任务且use_quartz_cron为false时才有该属性:
|
dispatch_interval |
Integer |
调度周期,和period字段一起可以确定每隔多长时间调度一次,只有定时任务且use_quartz_cron为false时才有该属性。 |
position |
String |
标识最近一次任务执行到哪一个阶段:
|
execute_status |
String |
任务最近一次执行状态:
|
source_app_id |
String |
任务源端数据源所属应用ID。 |
source_app_name |
String |
任务源端数据源所属应用名称。 |
source_instance_id |
String |
任务源端数据源所属实例ID。 |
target_app_id |
String |
任务目标端数据源所属应用ID。 |
target_app_name |
String |
任务目标端数据源所属应用名称。 |
target_instance_id |
String |
任务目标端数据源所属实例ID。 |
ext_type |
String |
任务扩展类型,当前如果是CDC组合任务,该字段为CDC,否则为null。 |
enterprise_project_id |
String |
任务所属企业项目ID,默认为0。 |
task_tag |
String |
任务标签。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
状态码: 200
OK
{ "total" : 99999, "size" : 99999, "entities" : [ { "task_id" : "id123456789", "task_name" : "fdi_task_name", "task_type" : "TIMING", "status" : 0, "last_execute_time" : 1603243428000, "use_quartz_cron" : false, "cron" : "0 */15 * * * ?", "period" : "DAY", "dispatch_interval" : 1, "position" : "READER", "execute_status" : "RUNNING", "source_app_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "source_app_name" : "source-app", "source_instance_id" : "source-instance", "target_app_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "target_app_name" : "target-app", "target_instance_id" : "target-instance", "ext_type" : "CDC", "enterprise_project_id" : "string", "task_tag" : "string" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。