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

  • 前提条件:具有目标项目空间的访问权限。如果您没有项目空间的访问权限,DMS管理员、DBA或空间管理员可以通过调用AddLhMembers将您添加为目标项目空间成员。
  • 补充说明:如果您的用户角色为DMS管理员或空间管理员,可通过指定用户ID查询某个项目空间中与该用户相关的应用场景和任务流列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListLhTaskFlowAndScenario

系统规定参数。取值:ListLhTaskFlowAndScenario

SpaceId Long 24

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

UserId Long 51****

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

Tid Long 3***

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

RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RawDAGList Array of Dag

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

Dag
Id Long 134137****

任务流ID。

CreatorId String 51****

创建人的用户ID。

IsDeleted Boolean false

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

  • true:已删除
  • false:没有删除
DemoId String -

扩展字段,暂无含义。

DeployId Long 12**

最近一次部署记录的ID。

DataFlowId Long -

扩展字段,暂无含义。

ScenarioId Long 2**

应用场景ID。

SpaceId Long 1

项目空间ID。

CreatorNickName String Creator_Name

创建人的昵称。

DagOwnerNickName String Owner_Name

任务流Owner的昵称。

CanEdit Boolean true

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

  • true:支持修改
  • false:不支持修改
Status Integer 2

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

  • 0:无效
  • 1:无调度配置
  • 2:等待调度
LatestInstanceStatus Integer 0

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

  • 0:无效
  • 1:无调度配置
  • 2:等待调度
LatestInstanceTime Integer 2022-04-14

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

DagName String Dag_Name

任务流名称。

DagOwnerId String 51****

任务流Owner的用户ID。

ScenarioDAGList Array of ScenarioDAG

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

ScenarioDAG
Scenario Object

业务场景信息列表。

ScenarioName String Scenario_2

应用场景名称。

CreatorId String 51****

创建人的用户ID。

Description String test

描述信息。

DagList Array of Dag

任务流信息列表。

Dag
Id Long 9***

任务流ID。

CreatorId String 51****

创建人的用户ID。

IsDeleted Boolean false

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

  • true:已删除
  • false:没有删除
DemoId String -

扩展字段,暂无含义。

DeployId Long 12**

最近一次部署记录的ID。

DataFlowId Long -

扩展字段,暂无含义。

ScenarioId Long 2**

应用场景ID。

SpaceId Long 1

项目空间ID。

CreatorNickName String Creator_Name

创建人的昵称。

DagOwnerNickName String Owner_Name

任务流Owner昵称。

CanEdit Boolean true

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

  • true:支持修改
  • false:不支持修改
Status Integer 1

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

  • 0:无效
  • 1:无调度配置
  • 2:等待调度
LatestInstanceStatus Integer 1

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

  • 0:无效
  • 1:无调度配置
  • 2:等待调度
LatestInstanceTime Integer 2022-04-14

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

DagName String Dag_Name

任务流名称。

DagOwnerId String 51****

任务流Owner的用户ID。

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

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

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

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListLhTaskFlowAndScenario
&SpaceId=24
&UserId=51****
&Tid=3***
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLhTaskFlowAndScenarioResponse>
    <RawDAGList>
        <CreatorId>51****</CreatorId>
        <IsDeleted>false</IsDeleted>
        <DemoId>-</DemoId>
        <SpaceId>1</SpaceId>
        <CreatorNickName>Creator_Name</CreatorNickName>
        <DagOwnerNickName>Owner_Name</DagOwnerNickName>
        <CanEdit>true</CanEdit>
        <Status>2</Status>
        <LatestInstanceStatus>0</LatestInstanceStatus>
        <DagName>Dag_Name</DagName>
        <DagOwnerId>51****</DagOwnerId>
    </RawDAGList>
    <ScenarioDAGList>
        <Scenario>
            <ScenarioName>Scenario_2</ScenarioName>
            <CreatorId>51****</CreatorId>
            <Description>test</Description>
        </Scenario>
        <DagList>
            <CreatorId>51****</CreatorId>
            <IsDeleted>false</IsDeleted>
            <DemoId>-</DemoId>
            <SpaceId>1</SpaceId>
            <CreatorNickName>Creator_Name</CreatorNickName>
            <DagOwnerNickName>Owner_Name</DagOwnerNickName>
            <CanEdit>true</CanEdit>
            <Status>1</Status>
            <LatestInstanceStatus>1</LatestInstanceStatus>
            <DagName>Dag_Name</DagName>
            <DagOwnerId>51****</DagOwnerId>
        </DagList>
    </ScenarioDAGList>
    <RequestId>48602B78-0DDF-414C-8688-70CAB6070115</RequestId>
    <Success>true</Success>
</ListLhTaskFlowAndScenarioResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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