ListWorkflowDefinitions - 获取数据开发工作流列表 - 大数据开发治理平台 DataWorks

分页获取数据开发工作流列表，也可以根据筛选条件对工作流进行筛选。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	10000
Type	string	否	筛选条件：工作流的类型可选值 CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	否	负责人的 ID，即工作空间管理员的账号 UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号 UID。	110755000425XXXX
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大为 100 条。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于定位日志，排查问题。	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	分页信息
TotalCount	integer	满足条件的数据总条数。	227
PageSize	integer	每页显示的条数	10
PageNumber	integer	请求的数据页数，用于翻页。	1
WorkflowDefinitions	array<object>	查询到的工作流列表
workflowDefinition	object
ProjectId	string	工作流所在 DataWorks 空间的 ID。	4710
Owner	string	责任人	110755000425XXXX
CreateTime	long	创建工作流时间戳	1698057323000
ModifyTime	long	最近修改工作流的时间戳	1698057323000
Description	string	描述	工作流描述
Type	string	工作流类型可选值 CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	脚本信息
Path	string	脚本路径	XX/OpenAPI测试/工作流测试/OpenAPI测试工作流Demo
Runtime	object	运行时
Command	string	命令	WORKFLOW
Id	string	脚本 id	698002781368644XXXX
Id	string	唯一 ID	463497880880954XXXX
Name	string	工作流名称	OpenAPI测试工作流Demo

示例

正常返回示例

JSON格式

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": "4710",
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "工作流描述",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI测试/工作流测试/OpenAPI测试工作流Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Id": "463497880880954XXXX",
        "Name": "OpenAPI测试工作流Demo"
      }
    ]
  }
}

错误码

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