ListLhTaskFlowAndScenario - 查询项目空间中业务场景对应的任务流列表

更新时间:
复制 MD 格式

查询DMS数仓开发项目空间中业务场景对应的任务流列表。

接口说明

  • 前提条件:具有目标项目空间的访问权限。如果您没有项目空间的访问权限,DMS 管理员、DBA 或空间管理员可以通过调用 AddLhMembers 将您添加为目标项目空间成员。

  • 补充说明:如果您的用户角色为 DMS 管理员或空间管理员,可通过指定用户 ID 查询某个项目空间中与该用户相关的应用场景和任务流列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListLhTaskFlowAndScenario

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SpaceId

integer

项目空间 ID(Id),可通过调用接口 GetLhSpaceByName 获取该参数的值。

24

UserId

integer

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

51****

Tid

integer

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

3***

返回参数

名称

类型

描述

示例值

object

RawDAGList

object

Dag

array<object>

默认业务场景的任务流列表。

object

默认业务场景的任务流列表。

Id

integer

任务流 ID。

134137****

CreatorId

string

创建人的用户 ID。

51****

IsDeleted

boolean

任务流是否已被删除,返回值如下:

  • true:已删除

  • false:没有删除

false

DemoId

string

扩展字段,暂无含义。

-

DeployId

integer

最近一次部署记录的 ID。

12**

DataFlowId

integer

扩展字段,暂无含义。

-

ScenarioId

integer

应用场景 ID。

2**

SpaceId

integer

项目空间 ID。

1

CreatorNickName

string

创建人的昵称。

Creator_Name

DagOwnerNickName

string

任务流 Owner 的昵称。

Owner_Name

CanEdit

boolean

任务流是否支持编辑,返回值如下:

  • true:支持修改

  • false:不支持修改

true

Status

integer

任务流状态,返回值如下:

  • 0:无效

  • 1:无调度配置

  • 2:等待调度

2

LatestInstanceStatus

integer

最近一个运行记录的状态,返回值如下:

  • 0:无效

  • 1:无调度配置

  • 2:等待调度

0

LatestInstanceTime

integer

最近一个运行记录的创建时间。

2022-04-14

DagName

string

任务流名称。

Dag_Name

DagOwnerId

string

任务流 Owner 的用户 ID。

51****

ScenarioDAGList

object

ScenarioDAG

array<object>

其他业务场景的任务流列表。

array<object>

业务场景的任务流列表。

Scenario

object

业务场景信息列表。

ScenarioName

string

应用场景名称。

Scenario_2

CreatorId

string

创建人的用户 ID。

51****

Description

string

描述信息。

test

DagList

object

Dag

array<object>

任务流信息列表。

object

任务流信息列表。

Id

integer

任务流 ID。

9***

CreatorId

string

创建人的用户 ID。

51****

IsDeleted

boolean

任务流是否已被删除,返回值如下:

  • true:已删除

  • false:没有删除

false

DemoId

string

扩展字段,暂无含义。

-

DeployId

integer

最近一次部署记录的 ID。

12**

DataFlowId

integer

扩展字段,暂无含义。

-

ScenarioId

integer

应用场景 ID。

2**

SpaceId

integer

项目空间 ID。

1

CreatorNickName

string

创建人的昵称。

Creator_Name

DagOwnerNickName

string

任务流 Owner 昵称。

Owner_Name

CanEdit

boolean

任务流是否支持编辑。返回值如下:

  • true:支持修改

  • false:不支持修改

true

Status

integer

任务流状态,返回值如下:

  • 0:无效

  • 1:无调度配置

  • 2:等待调度

1

LatestInstanceStatus

integer

最近一个运行实例的状态,返回值如下:

  • 0:无效

  • 1:无调度配置

  • 2:等待调度

1

LatestInstanceTime

integer

最近一个运行记录的创建时间。

2022-04-14

DagName

string

任务流名称。

Dag_Name

DagOwnerId

string

任务流 Owner 的用户 ID。

51****

RequestId

string

请求 ID。

48602B78-0DDF-414C-8688-70CAB6070115

ErrorCode

string

错误码。

UnknownError

ErrorMessage

string

错误信息。

UnknownError

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RawDAGList": {
    "Dag": [
      {
        "Id": 0,
        "CreatorId": "51****",
        "IsDeleted": false,
        "DemoId": "-",
        "DeployId": 0,
        "DataFlowId": 0,
        "ScenarioId": 0,
        "SpaceId": 1,
        "CreatorNickName": "Creator_Name",
        "DagOwnerNickName": "Owner_Name",
        "CanEdit": true,
        "Status": 2,
        "LatestInstanceStatus": 0,
        "LatestInstanceTime": 0,
        "DagName": "Dag_Name",
        "DagOwnerId": "51****"
      }
    ]
  },
  "ScenarioDAGList": {
    "ScenarioDAG": [
      {
        "Scenario": {
          "ScenarioName": "Scenario_2",
          "CreatorId": "51****",
          "Description": "test"
        },
        "DagList": {
          "Dag": [
            {
              "Id": 0,
              "CreatorId": "51****",
              "IsDeleted": false,
              "DemoId": "-",
              "DeployId": 0,
              "DataFlowId": 0,
              "ScenarioId": 0,
              "SpaceId": 1,
              "CreatorNickName": "Creator_Name",
              "DagOwnerNickName": "Owner_Name",
              "CanEdit": true,
              "Status": 1,
              "LatestInstanceStatus": 1,
              "LatestInstanceTime": 0,
              "DagName": "Dag_Name",
              "DagOwnerId": "51****"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情