文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API(V2)/ 作业开发API/ 查询实时集成作业详情 - ShowRealTimeJobDetails
更新时间:2026-08-05 GMT+08:00
分享

查询实时集成作业详情 - ShowRealTimeJobDetails

功能介绍

查询实时集成作业的详细信息,仅支持一键入湖(OneClickCDC)类型的实时集成作业。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/factory/real-time-jobs/{job_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

job_name

String

数据开发作业名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),使用Token认证时必选,最小长度:0,最大长度:4096。

X-Project-Id

String

project_id,项目编号。获取方法请参见项目ID和账号ID

多project场景采用AK/SK认证的接口请求,则该字段必选。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

job_id

String

作业ID。

state

String

作业状态。

  • EXCEPTION:异常

  • STOPPING:停止中

  • SUBMITTING:提交中

  • RUNNING:运行中

  • STOPPED:已停止

  • SUCCESS:成功

migration_type

String

作业迁移类型。

  • INCREMENTAL_DATA:增量数据

  • HISTORY_DATA:历史数据

startup_timestamp

String

INCREMENTAL_DATA作业启动的时间位点。

job_engine_version

String

运行作业时的引擎版本。

cluster_engine_version

String

作业关联资源组的引擎版本。

cluster_type

String

资源组类型。

tracking_url

String

MRS Flink作业trackingUrl。

metric_info

String

作业指标信息。

task_details

Array of TaskDetailInfo objects

任务详情列表。

表4 TaskDetailInfo

参数

参数类型

描述

task_id

String

集成任务ID。

task_name

String

任务名称,长度限制0-57个字符。

monitor_report_id

String

DLF作业ID。

task_type

String

任务类型。

  • FLINK:Flink类型

  • SPARK:Spark类型

  • DRS:DRS类型

running_status

String

作业运行状态。

  • INITIALIZING:初始化中

  • SNAPSHOT:全量阶段

  • BINLOG:增量阶段

external_job_id

String

计算作业ID,DLI/CCE/DRS执行的作业ID。

source_type

String

源端类型。

target_type

String

目的端类型。

tracking_url

String

MRS Flink作业trackingUrl。

state

String

任务状态。

  • EXCEPTION:异常

  • STOPPING:停止中

  • SUBMITTING:提交中

  • RUNNING:运行中

  • STOPPED:已停止

  • SUCCESS:成功

error_msg

String

错误信息。

create_time

Long

任务创建时间,毫秒时间戳。

update_time

Long

任务更新时间,毫秒时间戳。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询名称为my_realtime_job的数据开发作业的实时集成作业详情

GET /v2/62099355b894428e8916573ae635f1f9/factory/real-time-job/my_realtime_job

响应示例

状态码:200

成功,返回实时集成作业详情。

{
  "is_success" : true,
  "message" : "",
  "job_id" : "36da30dc-b1ea-4f9d-96e1-ddfec9098695",
  "state" : "RUNNING",
  "migration_type" : "INCREMENTAL_DATA",
  "startup_timestamp" : "1701934124000",
  "job_engine_version" : "23.12.0",
  "cluster_engine_version" : "23.12.0",
  "cluster_type" : "MRS",
  "tracking_url" : "https://192.168.0.2/xxxx/application_1",
  "metric_info" : "{\"numRecordsIn\":\"1000\",\"numRecordsOut\":\"980\"}",
  "task_details" : [ {
    "task_id" : "36da30dc-b1ea-4f9d-96e1-ddfec9098695",
    "task_name" : "DM_36da30dc-b1ea-4f9d-96e1-ddfec9098695",
    "monitor_report_id" : "123456",
    "task_type" : "FLINK",
    "running_status" : "BINLOG",
    "external_job_id" : "4ac07bd4-850b-4c91-be30-6659cc71ce66",
    "source_type" : "mysql",
    "target_type" : "kafka",
    "tracking_url" : "https://192.168.0.2/xxxx/application_1",
    "state" : "RUNNING",
    "error_msg" : "",
    "create_time" : 1516952770835,
    "update_time" : 1516952770835
  } ]
}

状态码:400

失败,错误状态响应信息。

{
  "error_code" : "DLF.30100",
  "error_msg" : "Job [my_realtime_job] does not exist."
}

状态码

状态码

描述

200

成功,返回实时集成作业详情。

400

失败,错误状态响应信息。

相关文档