分页获取数据开发工作流列表，也可以根据筛选条件对工作流进行筛选。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 | 10000 |
| Type | string | 否 | 筛选条件：工作流的类型，未填写则默认为 CycleWorkflow 可选值
| CycleWorkflow |
| Owner | string | 否 | 负责人的 ID，即工作空间管理员的账号 UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号 UID。 | 110755000425XXXX |
| Name | string | 否 | 工作流的名称，支持模糊搜索。 | test |
| PageNumber | integer | 否 | 请求的数据页数，用于翻页。 | 1 |
| PageSize | integer | 否 | 每页显示的条数，默认为 10 条，最大为 100 条。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
"PagingInfo": {
"TotalCount": 227,
"PageSize": 10,
"PageNumber": 1,
"WorkflowDefinitions": [
{
"ProjectId": 4710,
"Owner": "110755000425XXXX",
"CreateTime": 1698057323000,
"ModifyTime": 1698057323000,
"Description": "Workflow description",
"Type": "CycleWorkflow",
"Script": {
"Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
"Runtime": {
"Command": "WORKFLOW"
},
"Id": 0
},
"Id": 0,
"Name": "OpenAPI test workflow Demo"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-01-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |