ListPipelines - 获取工作流列表

获取工作流列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/pipelines HTTP/1.1

请求参数

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

工作流列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页显示的工作流数量。

10
PipelineIdentifierstring

需要过滤的工作流标识。您可以在 ListPipelines 查询结果中获取 Identifier

SqlWriteTable_2
PipelineProviderstring

需要过滤的工作流提供者。

  • PAI 官方提供的工作流,Provider 为 pai。
  • 您创建的工作流,该值为您的阿里云账号 ID。
pai
PipelineVersionstring

需要过滤的工作流版本。

v1
WorkspaceIdstring

需要过滤的工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

726**
FuzzyMatchingboolean

是否支持模糊匹配。取值如下:

  • false:不支持
  • true:支持
false

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

DA869D1B-035A-43B2-ACC1-C56681B****
Pipelinesarray<object>

工作流列表。

Pipelinesobject

工作流。

PipelineIdstring

工作流 ID。

pipeline-c0h44g3wlwkj8o*****
GmtCreateTimestring

创建 UTC 时间,日期格式 ISO8601。

2021-01-06T14:32:50Z
GmtModifiedTimestring

修改 UTC 时间,日期格式 ISO8601。

2021-01-06T22:26:24Z
Providerstring

工作流提供者。

  • PAI 平台提供的工作流 Provider 为 pai。
  • 您创建的工作流,该值为您的阿里云账号 ID。
pai
Identifierstring

工作流标识。

SqlWriteTable_2
Versionstring

工作流版本。

v1
Uuidstring

工作流当前版本标识,用户每次更新,会生成该 uuid。

q8dp9hklueznh*****
WorkspaceIdstring

工作空间 ID。

726**
TotalCountlong

总数。

15

示例

正常返回示例

JSON格式

{
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681B****",
  "Pipelines": [
    {
      "PipelineId": "pipeline-c0h44g3wlwkj8o*****",
      "GmtCreateTime": "2021-01-06T14:32:50Z",
      "GmtModifiedTime": "2021-01-06T22:26:24Z",
      "Provider": "pai",
      "Identifier": "SqlWriteTable_2",
      "Version": "v1",
      "Uuid": "q8dp9hklueznh*****",
      "WorkspaceId": "726**"
    }
  ],
  "TotalCount": 15
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-24API 内部配置变更,不影响调用查看变更详情
2021-03-02OpenAPI 入参发生变更查看变更详情