ListJobs - 获取工作流草稿作业列表

获取工作流草稿作业列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/jobs HTTP/1.1

请求参数

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

工作流草稿 ID。

draft-8up80bg0k1q23stml6
Creatorstring

创建人的 UID。

13266*******76250
Orderstring

默认按创建时间排序,排列顺序:

  • DESC:降序。
  • ASC:升序。
DESC
PageNumberinteger

当前页码。默认值:1。

1
PageSizeinteger

分页查询时每页的大小,默认为 20。

10

返回参数

名称类型描述示例值
object

响应结果。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Jobsarray<object>

作业列表。

Jobobject

作业详情。

ExperimentIdstring

工作流草稿 ID。

draft-4x4iv3a9enuxw4vgka
WorkspaceIdstring

工作空间 ID。

94436
JobIdstring

任务 ID。

job-mewqhd72nsrqujn1px
ExecuteTypestring

执行的类型:

  • EXECUTE_ALL(运行工作流草稿中所有节点)
  • EXECUTE_ONE(执行指定节点)
  • EXECUTE_TO_HERE(从根节点执行到该节点)
  • EXECUTE_FROM_HERE(从指定的节点开始运行)
  • EXECUTE_CHILDREN(执行指定节点的下游节点)
EXECUTE_ALL
NodeIdstring

工作流草稿中的节点 ID。

nodeId1
RunIdstring

对应的 PaiFlow 的 Pipeline Run ID。

flow-aayfouai80i980ncvz
PaiflowNodeIdstring

PaiFlow 中的 Pipeline Run 节点 ID。

node-xdfasf8ewxfdaddl
Creatorstring

创建人的 UID。

17677*******89598
Statusstring

作业的状态,目前状态有:

  • Initialized: 初始化完成
  • Starting:开始
  • WorkflowServiceStarting:准备提交
  • Running:运行中
  • Succeeded:运行成功
  • Failed:运行失败
  • Terminating:终止中
  • Terminated:已终止
  • Unknown:未知
  • Skipped:跳过(前序节点失败导致)
  • ReadyToSchedule:准备运行(前序节点未完成导致)
Running
GmtCreateTimestring

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

2021-01-21T17:12:35.232Z

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Jobs": [
    {
      "ExperimentId": "draft-4x4iv3a9enuxw4vgka",
      "WorkspaceId": "94436",
      "JobId": "job-mewqhd72nsrqujn1px",
      "ExecuteType": "EXECUTE_ALL",
      "NodeId": "nodeId1",
      "RunId": "flow-aayfouai80i980ncvz",
      "PaiflowNodeId": "node-xdfasf8ewxfdaddl",
      "Creator": "17677*******89598",
      "Status": "Running",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-13API 内部配置变更,不影响调用查看变更详情