GetExperimentStatus - 查询工作流草稿状态_人工智能平台 PAI(PAI)-阿里云帮助中心

获取工作流草稿以及工作流草稿中节点的状态。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
paidesigner:GetPipelineDraftStatus	get	全部资源 *	无	无

请求语法

GET /api/v1/experiments/{ExperimentId}/status HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ExperimentId	string	是	工作流草稿 ID。	draft-4c60c4txtaexfum1zx

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E
Status	string	工作流草稿状态，目前有 Stopped 和 Running 两个状态： Running：工作流草稿有运行中的作业。 Stopped：工作流草稿中没有运行中的作业。	Running
Nodes	array<object>	工作流草稿中的节点状态。
Node	object	节点信息。
NodeId	string	工作流草稿中的节点 ID。	id-2317-1608984201281-74996
JobId	string	该节点最近一次运行创建的工作流草稿作业 ID。	job-mewqhd72nsrqujn1px
RunId	string	该节点最近一次运行创建的 PaiFlow PipelineRun 的 ID。	flow-wayrh3k605s7i51wey
RunNodeId	string	该节点最近一次运行创建的 PaiFlow PipelineRun 中对应的节点 ID。	node-6hc0eocnmzf4pk9njc
Status	string	任务状态，状态和 paiflow 中状态一致，目前状态有： Initialized: 初始化完成 Starting：开始 WorkflowServiceStarting：准备提交 Running：运行中 Succeeded：运行成功 Failed：运行失败 Terminating：终止中 Terminated：已终止 Unknown：未知 Skipped：跳过（前序节点失败导致） ReadyToSchedule：准备运行（前序节点未完成导致）	Running
StartedAt	string	任务开始时间。	2021-01-21T17:12:35.232Z
FinishedAt	string	任务结束时间。	2021-01-21T18:12:35.232Z

示例

正常返回示例

JSON格式

{
  "RequestId": "18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E",
  "Status": "Running",
  "Nodes": [
    {
      "NodeId": "id-2317-1608984201281-74996",
      "JobId": "job-mewqhd72nsrqujn1px",
      "RunId": "flow-wayrh3k605s7i51wey",
      "RunNodeId": "node-6hc0eocnmzf4pk9njc",
      "Status": "Running",
      "StartedAt": "2021-01-21T17:12:35.232Z",
      "FinishedAt": "2021-01-21T18:12:35.232Z"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史