All Products
Search
Document Center

:ListDags

更新時間:Apr 22, 2024

Queries the details of directed acyclic graphs (DAGs) for a single data backfill instance based on OpSeq.

Supported DAG types:

  • MANUAL: DAG for a manually triggered workflow

  • SMOKE_TEST: DAG for a smoke testing workflow

  • SUPPLY_DATA: DAG for a data backfill instance

  • BUSINESS_PROCESS_DAG: DAG for a one-time workflow

Supported DAG states:

  • CREATED: The DAG is created.

  • RUNNING: The DAG is running.

  • FAILURE: The DAG fails to run.

  • SUCCESS: The DAG is successfully run.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

ListDags

The operation that you want to perform. Set the value to ListDags.

OpSeq

Long

Yes

123

The sequence number that uniquely identifies the data backfill operation. You can call the GetDag operation to obtain the sequence number.

ProjectEnv

String

Yes

PROD

The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

Integer

200

The HTTP status code.

RequestId

String

7782a299-b291-4fee-8424-cf8058efa8e8

The request ID.

ErrorMessage

String

The connection does not exist.

The error message.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

The error code.

Success

Boolean

true

Indicates whether the request was successful.

Data

Object

The details of DAGs.

Dags

Array of Dag

The entities returned.

Type

String

MANUAL_FLOW

The type of the DAG. Valid values:

  • MANUAL: DAG for a manually triggered workflow

  • SMOKE_TEST: DAG for a smoke testing workflow

  • SUPPLY_DATA: DAG for a data backfill instance

  • BUSINESS_PROCESS_DAG: DAG for a one-time workflow

Status

String

FAILURE

The status of the DAG. Valid values:

  • CREATED

  • RUNNING

  • FAILURE

  • SUCCESS

FinishTime

Long

1605052800000

The end time.

CreateTime

Long

1605052800000

The creation time.

ProjectId

Long

112345

The workspace ID.

DagId

Long

351249682

The DAG ID.

Gmtdate

Long

1605052800000

The actual running time.

StartTime

Long

1605052800000

The start time.

CreateUser

String

1736629400048545

The user who created the DAG.

Bizdate

Long

1605052800000

The data timestamp.

Name

String

test_dag

The name of the DAG.

ModifyTime

Long

1605052800000

The time when the DAG was last modified.

OpSeq

Long

123

The sequence number of the operation.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDags
&OpSeq=123
&ProjectEnv=PROD
&<Common request parameters>

Sample success responses

XML format

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 format

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
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.