文档

ListDags - 获取单次补数据的所有Dag详情

更新时间:

根据OpSeq(补数据唯一标识)获取单次补数据的所有Dag详情。

接口说明

Dag Type 的类型:

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

Dag Status 的类型:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
OpSeqlong

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

123
ProjectEnvstring

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

PROD

返回参数

名称类型描述示例值
object

返回实体。

HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

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

7782a299-b291-4fee-8424-cf8058efa8e8
ErrorMessagestring

错误信息。

The connection does not exist.
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true
Dataobject

Dag 的详情信息。

Dagsobject []

返回的实体。

Typestring

DAG 的类型。取值如下:

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

DAG 的状态。取值如下:

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

结束时间。

1605052800000
CreateTimelong

创建时间。

1605052800000
ProjectIdlong

工作空间的 ID。

112345
DagIdlong

DagId。

351249682
Gmtdatelong

Gmtdate。

1605052800000
StartTimelong

开始时间。

1605052800000
CreateUserstring

创建人。

1736629400048545
Bizdatelong

业务日期。

1605052800000
Namestring

Dag 的名称。

test_dag
ModifyTimelong

修改时间。

1605052800000
OpSeqlong

操作的标识码。

123

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)