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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListManualDagInstances

要执行的操作。

RegionId String cn-shanghai

地域信息,通常是服务所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectEnv String RPOD

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

ProjectName String test_workspace

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

DagId String 7000001231241

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

返回数据

名称 类型 示例值 描述
RequestId String SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

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

Instances Array of Instances

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

Status String SUCCESS

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

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

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

BizDate Long 1605178414676

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

CycTime Long 1605178414676

实例任务的定时时间。

FinishTime Long 1605178414676

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

CreateTime Long 1605178414676

实例任务的创建时间。

DagId Long 350850491

手动业务流程实例的DagId。

InstanceId Long 11726873619

内部实例ID。

BeginWaitResTime Long 1605178414676

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

TaskType String MANUAL

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

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

实例的参数信息。

DagType String 5

手动业务流程的标识。

NodeName String test2

节点的名称。

BeginWaitTimeTime Long 1605178414676

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

NodeId Long 37851

业务流程的内部节点ID。

ModifyTime Long 1605178414676

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

CreateUser String Test

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListManualDagInstances
&ProjectEnv=RPOD
&ProjectName=test_workspace
&DagId=7000001231241
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListManualDagInstancesResponse>
    <RequestId>SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF</RequestId>
    <Instances>
        <Status>SUCCESS</Status>
        <BeginRunningTime>1605178414676</BeginRunningTime>
        <BizDate>1605178414676</BizDate>
        <CycTime>1605178414676</CycTime>
        <FinishTime>1605178414676</FinishTime>
        <CreateTime>1605178414676</CreateTime>
        <DagId>350850491</DagId>
        <InstanceId>11726873619</InstanceId>
        <BeginWaitResTime>1605178414676</BeginWaitResTime>
        <TaskType>MANUAL</TaskType>
        <ParamValues>xxx=yyy</ParamValues>
        <DagType>5</DagType>
        <NodeName>test2</NodeName>
        <BeginWaitTimeTime>1605178414676</BeginWaitTimeTime>
        <NodeId>37851</NodeId>
        <ModifyTime>1605178414676</ModifyTime>
        <CreateUser>Test</CreateUser>
    </Instances>
</ListManualDagInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  }
}

错误码

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