GetJob API查询工作流草稿作业详细信息-人工智能平台 PAI-阿里云

查询工作流草稿作业详细信息。

调试

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

授权信息

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

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

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

请求语法

GET /api/v1/jobs/{JobId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Verbose	boolean	否	是否查询任务详情。	true
JobId	string	是	任务 ID。	job-6xfhrofqx93y139fg3

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E
ExperimentId	string	工作流草稿 ID。	draft-rbvg5wzljzjhc9ks92
WorkspaceId	string	工作空间 ID。	86995
JobId	string	作业 ID。	job-6xfhrofqx93y139fg3
Snapshot	string	作业快照。	{}
ExecuteType	string	执行的类型: EXECUTE_ALL(运行工作流草稿中所有节点) EXECUTE_ONE(执行指定节点) EXECUTE_TO_HERE(从根节点执行到该节点) EXECUTE_FROM_HERE(从指定的节点开始运行) EXECUTE_CHILDREN(执行指定节点的下游节点)	EXECUTE_TO_HERE
NodeId	string	工作流草稿中的节点 ID。	id-xxxxx
RunInfo	string	该作业对应的 Pipeline Run 的 Manifests。	apiVersion: "core/v1" metadata: version: "v1" identifier: "1de8f7c8-a9d8-4433-9e87-d95979ccab14" annotations: {} spec: inputs: artifacts: [] parameters: - name: "execution" type: "Map" arguments: artifacts: [] parameters: [] dependencies: [] initContainers: [] sideCarContainers: [] pipelines: - apiVersion: "core/v1" metadata: provider: "pai" name: "id-2d88-1608982098027-91558" version: "v1" identifier: "type_transform" annotations: {}
RunId	string	对应的 PaiFlow 的 Pipeline Run ID。	flow-lcs8ez11961l6urc3m
PaiflowNodeId	string	PaiFlow 中的 Pipeline Run 节点 ID。	node-5dzotrnwyzfxmbwwc8
Creator	string	创建者用户 ID。	13266*******76250
Status	string	作业状态。取值： Initialized: 初始化完成 Starting：开始 WorkflowServiceStarting：准备提交 Running：运行中 Succeeded：运行成功 Failed：运行失败 Terminating：终止中 Terminated：已终止 Unknown：未知 Skipped：跳过（前序节点失败导致） ReadyToSchedule：准备运行（前序节点未完成导致）	Succeeded
GmtCreateTime	string	作业创建时间。	2021-01-21T17:12:35.232Z
Arguments	string	PaiFlow Pipeline Run 的 Arguments。	--- arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service.cn-shanghai.maxcompute.aliyun.com/api" odpsProject: "xxxxxxx"

示例

正常返回示例

JSON格式

{
  "RequestId": "18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E",
  "ExperimentId": "draft-rbvg5wzljzjhc9ks92",
  "WorkspaceId": 86995,
  "JobId": "job-6xfhrofqx93y139fg3\n",
  "Snapshot": {},
  "ExecuteType": "EXECUTE_TO_HERE",
  "NodeId": "id-xxxxx",
  "RunInfo": "apiVersion: \"core/v1\"\nmetadata:\n  version: \"v1\"\n  identifier: \"1de8f7c8-a9d8-4433-9e87-d95979ccab14\"\n  annotations: {}\nspec:\n  inputs:\n    artifacts: []\n    parameters:\n    - name: \"execution\"\n      type: \"Map\"\n  arguments:\n    artifacts: []\n    parameters: []\n  dependencies: []\n  initContainers: []\n  sideCarContainers: []\n  pipelines:\n  - apiVersion: \"core/v1\"\n    metadata:\n      provider: \"pai\"\n      name: \"id-2d88-1608982098027-91558\"\n      version: \"v1\"\n      identifier: \"type_transform\"\n      annotations: {}",
  "RunId": "flow-lcs8ez11961l6urc3m",
  "PaiflowNodeId": "node-5dzotrnwyzfxmbwwc8\n",
  "Creator": "13266*******76250",
  "Status": "Succeeded",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "Arguments": "---\narguments:\n  parameters:\n  - name: \"execution_maxcompute\"\n    value:\n      endpoint: \"http://service.cn-shanghai.maxcompute.aliyun.com/api\"\n      odpsProject: \"xxxxxxx\""
}

错误码

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

变更历史

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

暂无变更历史