调用ListJobs获取工作流草稿作业列表-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

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

调试

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

授权信息

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

请求语法

GET /api/v1/jobs HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ExperimentId	string	是	工作流草稿 ID。	draft-8up80bg0k1q23stml6
Creator	string	否	创建人的 UID。	13266*******76250
Order	string	否	默认按创建时间排序，排列顺序： DESC：降序。 ASC：升序。	DESC
PageNumber	integer	否	当前页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的大小，默认为 20。	10

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Jobs	array<object>	作业列表。
Job	object	作业详情。
ExperimentId	string	工作流草稿 ID。	draft-4x4iv3a9enuxw4vgka
WorkspaceId	string	工作空间 ID。	94436
JobId	string	任务 ID。	job-mewqhd72nsrqujn1px
ExecuteType	string	执行的类型: EXECUTE_ALL(运行工作流草稿中所有节点) EXECUTE_ONE(执行指定节点) EXECUTE_TO_HERE(从根节点执行到该节点) EXECUTE_FROM_HERE(从指定的节点开始运行) EXECUTE_CHILDREN(执行指定节点的下游节点)	EXECUTE_ALL
NodeId	string	工作流草稿中的节点 ID。	nodeId1
RunId	string	对应的 PaiFlow 的 Pipeline Run ID。	flow-aayfouai80i980ncvz
PaiflowNodeId	string	PaiFlow 中的 Pipeline Run 节点 ID。	node-xdfasf8ewxfdaddl
Creator	string	创建人的 UID。	17677*******89598
Status	string	作业的状态，目前状态有： Initialized: 初始化完成 Starting：开始 WorkflowServiceStarting：准备提交 Running：运行中 Succeeded：运行成功 Failed：运行失败 Terminating：终止中 Terminated：已终止 Unknown：未知 Skipped：跳过（前序节点失败导致） ReadyToSchedule：准备运行（前序节点未完成导致）	Running
GmtCreateTime	string	创建时间，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-13	API 内部配置变更，不影响调用	查看变更详情