首页 数据管理 DMS 开发参考 API参考 API目录 数据开发 任务编排 GetTaskInstanceRelation - 获取任务流运行记录的节点信息

GetTaskInstanceRelation - 获取任务流运行记录的节点信息

更新时间: 2023-09-27 16:24:29

调用GetTaskInstanceRelation接口,获取任务流运行记录的节点信息。

调试

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

调试

授权信息

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

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

请求参数

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

任务流ID,可通过调用接口ListTaskFlowListLhTaskFlowAndScenario获取该参数的值。

7***
DagInstanceIdlong

任务流运行记录ID(Id),可通过调用接口ListTaskFlowInstance获取该参数的值。

47****
Tidlong

租户ID,可通过调用接口GetUserActiveTenantListUserTenants获取该参数的值。

3***

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

028BF827-3801-5869-8548-F4A039256304
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
NodeListobject []

任务流运行记录的节点信息列表。

Idlong

任务节点运行记录ID。

14059
NodeIdlong

任务节点ID。

14059
NodeNamestring

任务节点名称。

Spark SQL-1
NodeTypeinteger

任务节点类型,返回值请参见NodeType参数说明

36
BusinessTimestring

业务时间。

2021-11-09 14:37:26
Statusinteger

任务节点运行状态,取值如下:

  • 0:等待调度
  • 1:正在运行
  • 2:挂起
  • 3:运行失败
  • 4:运行成功
  • 5:已完成
4
Messagestring

任务描述信息。

test
ExecuteTimelong

任务执行时间,单位为毫秒。

170655
EndTimestring

任务流运行结束时间,时间格式为yyyy-MM-DD HH:mm:ss。

2021-11-11 14:38:57

示例

正常返回示例

JSON格式

{
  "RequestId": "028BF827-3801-5869-8548-F4A039256304",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "NodeList": {
    "Node": [
      {
        "Id": 14059,
        "NodeId": 14059,
        "NodeName": "Spark SQL-1",
        "NodeType": 36,
        "BusinessTime": "2021-11-09 14:37:26",
        "Status": 4,
        "Message": "test",
        "ExecuteTime": 170655,
        "EndTime": "2021-11-11 14:38:57"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 数据管理 DMS 相关技术圈