GetWorkflowInstance - 获取工作流实例的详情 - 大数据开发治理平台 DataWorks

获取指定的工作流实例的详细信息。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	工作流实例的唯一标识符。	1234

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
WorkflowInstance	object	工作流实例的详细信息。
Id	integer	工作流实例的唯一标识符。	1234
WorkflowId	integer	所属工作流的 ID。	1234
WorkflowTaskInstanceId	integer	工作流实例对应的任务实例 ID。	1234
UnifiedWorkflowInstanceId	integer	统一工作流实例 Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。	1234
Name	string	名称。	WorkInstance1
Type	string	工作流实例的类型。 Normal：周期调度 Manual：手动任务 SmokeTest：测试 SupplementData：补数据 ManualWorkflow：手动工作流 TriggerWorkflow：触发式工作流	Normal
Status	string	工作流实例运行状态。 NotRun：未运行 Running：运行中 WaitTime：等待 TriggerTime 到来 CheckingCondition：分支条件检验 WaitResource：等待资源 Failure：执行失败 Success：执行成功 Checking：下发给数据质量校检	Success
BizDate	integer	业务日期。	1710239005403
StartedTime	integer	开始运行时间。	1710239005403
FinishedTime	integer	完成时间。	1710239005403
ProjectId	integer	项目 ID。	100
EnvType	string	项目环境。 Prod：生产 Dev：开发	Prod
Owner	string	工作流的责任人的账号 ID。	1000
CreateTime	integer	创建时间。	1710239005403
ModifyTime	integer	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000
WorkflowParameters	string	工作流参数。	周期工作流： key1=value1 key2=value2 手动业务流程： {"key1":"value1", "key2": "value2"}
Tags	array<object>	任务标签
	object
Key	string	标签键。	key1
Value	string	标签值。	value1

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "WorkflowInstance": {
    "Id": 1234,
    "WorkflowId": 1234,
    "WorkflowTaskInstanceId": 1234,
    "UnifiedWorkflowInstanceId": 1234,
    "Name": "WorkInstance1",
    "Type": "Normal",
    "Status": "Success",
    "BizDate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WorkflowParameters": "周期工作流：\nkey1=value1 key2=value2\n手动业务流程：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。