文档

ListManualDagInstances - 获取手动执行的业务流程实例的信息

更新时间:

获取手动执行的业务流程实例的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectEnvstring

运维中心的调度环境标识,包括 PROD(生产环境)和 DEV(开发环境)。

RPOD
ProjectNamestring

手动业务流程所属的工作空间名称。您可以进入 DataWorks 控制台,在工作空间配置页面获取。

test_workspace
DagIdstring

触发手动业务流程运行的 Dag 实例 ID。您可以调用 RunManualDagNodes 接口获取。

7000001231241

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID,用于定位日志,排查问题。

SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Instancesarray<object>

手动业务流程的内部实例列表。

object

返回数据。

Statusstring

实例任务的状态,取值如下:

  • NOT_RUN(未运行)
  • WAIT_TIME(等待定时时间 DueTime 或 CycleTime 到来)
  • WAIT_RESOURCE(等待资源)
  • RUNNING(运行中)
  • CHECKING(下发给数据质量进行数据校检)
  • CHECKING_CONDITION(正在进行分支条件校检)
  • FAILURE(执行失败)
  • SUCCESS(执行成功)
SUCCESS
BeginRunningTimelong

实例任务开始运行的时间。

1605178414676
BizDatelong

业务日期。通常为该任务运行时间的前一天。

1605178414676
CycTimelong

实例任务的定时时间。

1605178414676
FinishTimelong

实例任务运行的结束时间。

1605178414676
CreateTimelong

实例任务的创建时间。

1605178414676
DagIdlong

手动业务流程实例的 DagId。

350850491
InstanceIdlong

内部实例 ID。

11726873619
BeginWaitResTimelong

实例任务开始等待资源的时间。

1605178414676
TaskTypestring

实例任务的调度类型,取值如下:

  • NORMAL(0):正常调度任务。该任务被日常调度。
  • MANUAL(1):手动任务。该任务不会被日常调度。
  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。
  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。
  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。
  • REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。
MANUAL
ParamValuesstring

实例的参数信息。

xxx=yyy
DagTypestring

手动业务流程的标识。

5
NodeNamestring

节点的名称。

test2
BeginWaitTimeTimelong

实例任务开始等待调度的时间。

1605178414676
NodeIdlong

业务流程的内部节点 ID。

37851
ModifyTimelong

最近一次修改实例任务的时间。

1605178414676
CreateUserstring

触发实例运行的用户。例如,用户 Test 触发运行手动执行的业务流程实例,则 CreateUser 为 Test。

Test

示例

正常返回示例

JSON格式

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Instances": [
    {
      "Status": "SUCCESS",
      "BeginRunningTime": 1605178414676,
      "BizDate": 1605178414676,
      "CycTime": 1605178414676,
      "FinishTime": 1605178414676,
      "CreateTime": 1605178414676,
      "DagId": 350850491,
      "InstanceId": 11726873619,
      "BeginWaitResTime": 1605178414676,
      "TaskType": "MANUAL",
      "ParamValues": "xxx=yyy",
      "DagType": "5",
      "NodeName": "test2",
      "BeginWaitTimeTime": 1605178414676,
      "NodeId": 37851,
      "ModifyTime": 1605178414676,
      "CreateUser": "Test"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-25API 内部配置变更,不影响调用查看变更详情