ListManualDagInstances - 获取手动执行的业务流程实例的信息 - 大数据开发治理平台 DataWorks

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectEnv	string	是	运维中心的调度环境标识，包括 PROD（生产环境）和 DEV（开发环境）。	RPOD
ProjectName	string	是	手动业务流程所属的工作空间名称。您可以进入 DataWorks 控制台，在工作空间配置页面获取。	test_workspace
DagId	string	是	触发手动业务流程运行的 Dag 实例 ID。您可以调用 RunManualDagNodes 接口获取。	7000001231241

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID，用于定位日志，排查问题。	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Instances	array<object>	手动业务流程的内部实例列表。
Instances	object	返回数据。
Status	string	实例任务的状态，取值如下： NOT_RUN（未运行） WAIT_TIME（等待定时时间 DueTime 或 CycleTime 到来） WAIT_RESOURCE（等待资源） RUNNING（运行中） CHECKING（下发给数据质量进行数据校检） CHECKING_CONDITION（正在进行分支条件校检） FAILURE（执行失败） SUCCESS（执行成功）	SUCCESS
BeginRunningTime	long	实例任务开始运行的时间。	1605178414676
BizDate	long	业务日期。通常为该任务运行时间的前一天。	1605178414676
CycTime	long	实例任务的定时时间。	1605178414676
FinishTime	long	实例任务运行的结束时间。	1605178414676
CreateTime	long	实例任务的创建时间。	1605178414676
DagId	long	手动业务流程实例的 DagId。	350850491
InstanceId	long	内部实例 ID。	11726873619
BeginWaitResTime	long	实例任务开始等待资源的时间。	1605178414676
TaskType	string	实例任务的调度类型，取值如下： NORMAL(0)：正常调度任务。该任务被日常调度。 MANUAL(1)：手动任务。该任务不会被日常调度。 PAUSE(2)：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。 SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。 SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。 SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。 CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。 REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。	MANUAL
ParamValues	string	实例的参数信息。	xxx=yyy
DagType	string	手动业务流程的标识。	5
NodeName	string	节点的名称。	test2
BeginWaitTimeTime	long	实例任务开始等待调度的时间。	1605178414676
NodeId	long	业务流程的内部节点 ID。	37851
ModifyTime	long	最近一次修改实例任务的时间。	1605178414676
CreateUser	string	触发实例运行的用户。例如，用户 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-25	API 内部配置变更，不影响调用	查看变更详情