获取工作流任务详情信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
paiflow:GetPipelineRun | get | *全部资源 * |
| 无 |
请求语法
GET /api/v1/pipelineruns/{PipelineRunId} HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PipelineRunId | string | 是 | 工作流任务 ID。如何获取工作流任务 ID,请参见 ListPipelineRuns 。 | run-rbvg**********ks92 |
Verbose | boolean | 否 | 是否返回详细信息,取值如下。
| false |
ManifestType | string | 否 | 具体返回哪种类型的 Manifest 信息,取值如下。
| Raw |
TokenId | string | 否 | 被分享的工作流任务的 ID。 | https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e****** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA\n",
"PipelineRunId": "flow-j94y**********lf7a\n",
"Name": "testName",
"Status": "Succeeded",
"Manifest": {
"ApiVersion": "core/v1",
"Metadata": {
"NodeId": "node-n06d**********fc53",
"Provider": "155**********904",
"Name": "flow-j94y**********lf7a",
"Version": "v1",
"Identifier": "9fe11111-****-****-****-****ec811861",
"Namespace": null,
"DisplayName": "name",
"NodeType": "Dag"
},
"Spec": {}
},
"Arguments": {
"arguments": {
"parameters": [
{
"name": "execution",
"value": {
"endpoint": "http://service.******",
"odpsProject": "******",
"spec": {
"endpoint": "http://service.******",
"odpsProject": "*****"
},
"resourceType": "MaxCompute"
}
}
]
}
},
"UserId": "155**********904\n",
"ParentUserId": "155**********904\n",
"StartedAt": "2021-01-30T12:51:33.028Z\n",
"FinishedAt": "2021-01-30T12:52:33.028Z\n",
"NodeId": "node-n06d**********fc53\n",
"Duration": 60,
"WorkspaceId": 15945,
"Message": "error message\n",
"SourceType": "UNKNOWN",
"SourceId": "abcd*********hxfu\n",
"Options": {
"mlflow": {
"experimentId": "exp-**********"
}
},
"GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
"GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
"PipelineId": "pipeline-j94y**********lf7a\n",
"Accessibility": "PUBLIC",
"PipelineRunUri": "https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-12-21 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-12-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-06-14 | 新增 OpenAPI | 查看变更详情 |