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

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	工作流的唯一标识符。	1234
EnvType	string	否	项目环境。 Prod：生产 Dev：开发	Prod

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Workflow	object	工作流的详细信息。
Id	integer	工作流的唯一标识符。	1234
ProjectId	integer	项目 ID。	100
EnvType	string	项目环境。 Prod：生产 Dev：开发	Prod
Owner	string	责任人的账号 ID。	1000
Name	string	名称。	Workflow
Description	string	描述信息。	Test workflow
Trigger	object	触发方式。
Type	string	触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	Scheduler
Recurrence	string	触发时的运行模式，type=Scheduler 时生效。 Pause：暂停 Skip：空跑 Normal：正常运行	Normal
Cron	string	Cron 表达式，type=Scheduler 时生效。	00 00 00 * * ?
StartTime	string	周期触发生效时间，type=Scheduler 时生效。	1970-01-01 00:00:00
EndTime	string	周期触发失效时间，type=Scheduler 时生效。	1970-01-01 00:00:00
Dependencies	array<object>	依赖信息。
	object
Type	string	依赖类型。 CrossCycleDependsOnChildren：跨周期依赖一级子节点 CrossCycleDependsOnSelf：跨周期依赖自己 CrossCycleDependsOnOtherNode：跨周期依赖其他节点 Normal：同周期依赖	Normal
UpstreamOutput	string	上游任务的输出标识符。（`同周期依赖`且设置 input 内容时，返回此字段）	pre.odps_sql_demo_0
UpstreamTaskId	integer	上游任务的 Id。（`跨周期依赖其他节点`与`同周期依赖`未设置 input 内容时，返回此字段，其他情况不返回）	1234
Parameters	string	参数列表。	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	任务列表。
	array<object>
Id	integer	任务 ID。	1234
ProjectId	integer	项目 ID。	100
EnvType	string	项目环境。 Prod：生产 Dev：开发	Prod
Owner	string	任务的责任人的账号 ID。	1000
Name	string	任务的名称。	SQL node
Description	string	描述信息。	Test
WorkflowId	integer	所属工作流的 ID。	1234
Type	string	任务类型。	ODPS_SQL
BaselineId	integer	基线 ID。	1234
Priority	integer	任务优先级，最小值 1，最大值 8。取值越大，优先级越高。默认优先级为 1。	1
Timeout	integer	任务执行超时时间，单位为秒。	3600
RerunMode	string	任务是否允许重跑的配置。 AllDenied：失败或成功都不可重跑 FailureAllowed：只有失败可重跑 AllAllowed：失败或成功均可重跑	AllAllowed
RerunTimes	integer	重试次数，当任务设置为可重跑时生效。	3
RerunInterval	integer	重试时间间隔，单位秒。	60
RuntimeResource	object	运行环境配置，如资源组信息。
ResourceGroupId	string	任务运行配置的调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任务运行配置的镜像 ID。	i-xxxxxx
Cu	string	任务运行配置 CU 消耗。	0.25
DataSource	object	关联数据源信息。
Name	string	数据源名称。	mysql_test
CreateTime	integer	创建时间。	1710239005403
ModifyTime	integer	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000
TriggerRecurrence	string	触发时的运行模式。 Pause：暂停 Skip：空跑 Normal：正常运行	Normal
ClientUniqueCode	string	任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。	Task_0bc5213917368545132902xxxxxxxx
Outputs	object	输出信息。
TaskOutputs	array<object>	任务输出定义列表。
	object
Output	string	输出标识符。	pre.odps_sql_demo_0
Tags	array<object>	标签列表。
	object
Key	string	标签键。	key1
Value	string	标签值。	value1
CreateTime	integer	创建时间。	1710239005403
ModifyTime	integer	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000
ClientUniqueCode	string	工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。	Workflow_0bc5213917368545132902xxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Workflow": {
    "Id": 1234,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "Name": "Workflow",
    "Description": "Test workflow",
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "1970-01-01 00:00:00"
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": 1234
      }
    ],
    "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
    "Tasks": [
      {
        "Id": 1234,
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "Name": "SQL node",
        "Description": "Test",
        "WorkflowId": 1234,
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "TriggerRecurrence": "Normal",
        "ClientUniqueCode": "Task_0bc5213917368545132902xxxxxxxx"
      }
    ],
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx"
  }
}

错误码

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

变更历史

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