ListWorkflows - 获取工作流列表

分页获取工作流列表,也可以通过条件进行筛选查询。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ProjectIdlong

项目 ID。

100
EnvTypestring

项目环境。

  • Prod:生产
  • Dev:开发
Prod
Idsarray

工作流 ID 列表,可根据工作流 Id 批量查询多个工作流信息。

Idlong

工作流 ID。

1234
Namestring

名称。支持模糊查询。

Workflow1
Ownerstring

责任人的账号 ID。

1000
TriggerTypestring

触发方式类型。

  • Scheduler
  • Manual
Scheduler
SortBystring

排序字段。支持修改时间、创建时间等字段,格式为"排序字段+排序方式(Desc/Asc)"(Asc 可以缺省)。排序字段的枚举值如下:

  • ModifyTime (Desc/Asc)
  • CreateTime (Desc/Asc)
  • Id (Desc/Asc)

默认值:Id Desc

Id Desc
PageSizeinteger

每页的条目数,默认为 10。

10
PageNumberinteger

页码,从 1 开始,默认为 1。

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求的 ID,用于定位日志,排查问题。

22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfoobject

分页信息。

Workflowsarray<object>

工作流列表。

Workflowobject
Idlong

工作流的唯一标识符。

1234
Namestring

名称。

Workflow1
Descriptionstring

描述信息。

test
Triggerobject

触发方式。

Typestring

触发方式类型。

  • Scheduler:调度周期触发
  • Manual:手动触发
Scheduler
Recurrencestring

触发时的运行模式,type=Scheduler 时生效。

  • Pause:暂停
  • Skip:空跑
  • Normal:正常运行
Normal
Cronstring

Cron 表达式,type=Scheduler 时生效。

00 00 00 * * ?
StartTimestring

周期触发生效时间,type=Scheduler 时生效。

1970-01-01 00:00:00
EndTimestring

周期触发失效时间,type=Scheduler 时生效。

9999-01-01 00:00:00
Parametersstring

参数列表。

para1=$bizdate para2=$[yyyymmdd]
ClientUniqueCodestring

工作流的客户端唯一码,用于实现异步和幂等。创建时如果不指定,系统将自动生成,该代码将与资源 ID 进行唯一绑定。更新、删除资源时如果指定该参数,应与创建时的客户端唯一码保持统一。

Workflow_0bc5213917368545132902xxxxxxxx
ProjectIdlong

项目 ID。

100
EnvTypestring

项目环境。

  • Prod:生产
  • Dev:开发
Prod
Ownerstring

责任人的账号 ID。

1000
CreateTimelong

创建时间。

1710239005403
ModifyTimelong

修改时间。

1710239005403
CreateUserstring

创建用户的账号 ID。

1000
ModifyUserstring

修改用户的账号 ID。

1000
TotalCountinteger

数据总条数。

100
PageSizeinteger

每页的条目数。

10
PageNumberinteger

页码。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "Workflows": [
      {
        "Id": 1234,
        "Name": "Workflow1",
        "Description": "test",
        "Trigger": {
          "Type": "Scheduler",
          "Recurrence": "Normal",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00"
        },
        "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
        "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史