全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListDags

更新时间:Apr 09, 2024

调用ListDags接口,根据OpSeq(补数据唯一标识)获取单次补数据的所有Dag详情。

Dag Type的类型:

  • MANUAL:手动任务工作流
  • SMOKE_TEST:冒烟测试工作流
  • SUPPLY_DATA:补数据
  • BUSINESS_PROCESS_DAG:一次性业务流程工作流

Dag Status的类型:

  • CREATED:已创建
  • RUNNING:运行中
  • FAILURE:运行失败
  • SUCCESS:运行成功

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListDags

系统规定参数。取值:ListDags

OpSeq Long 123

补数据唯一标识。您可通过调用GetDag接口获取。

ProjectEnv String PROD

调度运维环境的标识:PROD表示生产环境,DEV表示开发环境。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 7782a299-b291-4fee-8424-cf8058efa8e8

请求的ID。用于定位日志,排查问题。

ErrorMessage String The connection does not exist.

错误信息。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

Success Boolean true

调用是否成功。

Data Object

Dag的详情信息。

Dags Array of Dag

返回的实体。

Type String MANUAL_FLOW

DAG的类型。取值如下:

  • MANUAL(手动任务工作流)
  • SMOKE_TEST(冒烟测试工作流)
  • SUPPLY_DATA(补数据)
  • BUSINESS_PROCESS_DAG(一次性业务流程工作流)
Status String FAILURE

DAG的状态。取值如下:

  • CREATED(已创建)
  • RUNNING(运行中)
  • FAILURE(运行失败)
  • SUCCESS(运行成功)
FinishTime Long 1605052800000

结束时间。

CreateTime Long 1605052800000

创建时间。

ProjectId Long 112345

工作空间的ID。

DagId Long 351249682

DagId。

Gmtdate Long 1605052800000

Gmtdate。

StartTime Long 1605052800000

开始时间。

CreateUser String 1736629400048545

创建人。

Bizdate Long 1605052800000

业务日期。

Name String test_dag

Dag的名称。

ModifyTime Long 1605052800000

修改时间。

OpSeq Long 123

操作的标识码。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDags
&OpSeq=123
&ProjectEnv=PROD
&公共请求参数

正常返回示例

XML格式

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

<ListDagsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>7782a299-b291-4fee-8424-cf8058efa8e8</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <Dags>
            <Type>MANUAL_FLOW</Type>
            <Status>FAILURE</Status>
            <FinishTime>1605052800000</FinishTime>
            <CreateTime>1605052800000</CreateTime>
            <ProjectId>112345</ProjectId>
            <DagId>351249682</DagId>
            <Gmtdate>1605052800000</Gmtdate>
            <StartTime>1605052800000</StartTime>
            <CreateUser>1736629400048545</CreateUser>
            <Bizdate>1605052800000</Bizdate>
            <Name>test_dag</Name>
            <ModifyTime>1605052800000</ModifyTime>
            <OpSeq>123</OpSeq>
        </Dags>
    </Data>
</ListDagsResponse>

JSON格式

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "7782a299-b291-4fee-8424-cf8058efa8e8",
  "ErrorMessage" : "The connection does not exist.",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "Dags" : [ {
      "Type" : "MANUAL_FLOW",
      "Status" : "FAILURE",
      "FinishTime" : 1605052800000,
      "CreateTime" : 1605052800000,
      "ProjectId" : 112345,
      "DagId" : 351249682,
      "Gmtdate" : 1605052800000,
      "StartTime" : 1605052800000,
      "CreateUser" : "1736629400048545",
      "Bizdate" : 1605052800000,
      "Name" : "test_dag",
      "ModifyTime" : 1605052800000,
      "OpSeq" : 123
    } ]
  }
}

错误码

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