全部产品
Search

搜索本产品

    数据管理 DMS：ListTaskFlowInstance - 获取任务流运行记录

    文档中心

    数据管理 DMS：ListTaskFlowInstance - 获取任务流运行记录

    更新时间：Nov 06, 2024

    调用ListTaskFlowInstance接口，获取任务流运行记录。

    调试

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

    授权信息

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

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

    请求参数

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

    任务流 ID，可通过调用接口 ListTaskFlow 或 ListLhTaskFlowAndScenario 获取该参数的值。

    		7***
    TriggerTypeinteger否

    触发类型，取值如下：

    • 0：周期调度
    • 1：手动运行
    		1
    StartTimeBeginstring否

    筛选出指定时间之后开始的任务流运行记录。时间格式为 yyyy-MM-DD。

    		2022-01-07
    StartTimeEndstring否

    筛选出指定时间之前开始的任务流运行记录。时间格式为 yyyy-MM-DD。

    		2022-04-08
    PageIndexinteger是

    第几页。

    		1
    PageSizeinteger是

    每页数据量。

    		20
    Tidlong否

    租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数。

    		3***
    UseBizDateboolean否

    调整筛选条件：
    true: StartTimeBegin 和 StartTimeEnd 为筛选业务时间区间范围。
    false: StartTimeBegin 和 StartTimeEnd 为任务运行时间区间范围。

    		true
    Statusinteger否

    任务节点运行状态，取值如下：

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		8CFF2295-8249-5287-B888-DBD4F0D76CB0
    ErrorCodestring

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		UnknownError
    Successboolean

    请求是否成功，返回值如下：

    • true：请求成功
    • false：请求失败
    		true
    DAGInstanceListarray<object>

    任务流运行记录列表。

    DAGInstanceobject

    任务流运行记录列表。

    Idlong

    运行记录 ID。

    		9234
    BusinessTimestring

    任务流业务时间，时间格式为 yyyy-MM-DD HH:mm:ss。

    		2021-11-10 14:37:26
    startTimestring

    任务流运行开始时间，时间格式为 yyyy-MM-DD HH:mm:ss。

    		2021-11-11 14:35:57
    EndTimestring

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

    		2021-11-11 14:38:57
    DagIdstring

    任务流 ID。

    		7***
    TriggerTypeinteger

    触发类型。返回值如下：

    • 0：周期调度
    • 1：手动运行
    		1
    Statusinteger

    任务流状态，返回值如下：

    • 0：等待调度
    • 1：运行中
    • 2：暂停
    • 3：失败
    • 4：成功
    • 5：完成
    		4
    Messagestring

    任务描述信息。

    		test
    HistoryDagIdlong

    历史任务流版本 ID。

    		2****
    DagNamestring

    任务流名称。

    		Spark_SQL_test
    OwnerNamestring

    任务流 Owner 的名称。

    		test_name
    DagVersionstring

    任务流版本。

    		[]
    TotalCountinteger

    满足条件运行记录总个数。

    		1

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DAGInstanceList": {
    "DAGInstance": [
      {
        "Id": 9234,
        "BusinessTime": "2021-11-10 14:37:26",
        "startTime": "2021-11-11 14:35:57\n",
        "EndTime": "2021-11-11 14:38:57",
        "DagId": "7***",
        "TriggerType": 1,
        "Status": 4,
        "Message": "test",
        "HistoryDagId": 0,
        "DagName": "Spark_SQL_test",
        "OwnerName": "test_name",
        "DagVersion": "[]"
      }
    ]
  },
  "TotalCount": 1
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-05-25OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情