ListInstances - 获取实例的列表

更新时间:
复制 MD 格式

调用ListInstances获取实例的列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ProjectEnv

string

运行的环境,包括 PROD(生产环境)和 DEV(开发环境)。

枚举值:

  • PROD :

    生产环境

  • DEV :

    开发环境

PROD

NodeId

integer

节点的 ID。您可以调用 ListNodes 查看节点 ID 信息。

100000000000

NodeName

string

节点的名称。您可以调用 ListNodes 查看节点名称。

openmr_8****

Owner

string

负责人的 ID,即工作空间管理员的账号 UID。您可登录阿里云控制台后,在账号管理的安全管理中查看账号 UID。

193379****

ProjectId

integer

工作空间的 ID。您可以调用 ListProjects 查看空间 ID 信息。

12345

BizName

string

业务流程的名称。您可以调用 ListBusiness 查看业务流程信息。

test_bizName

ProgramType

string

节点的类型。您可以调用 ListNodes 查看节点类型。

ODPS_SQL

PageNumber

integer

页码数,用于翻页。最小值为 1,最大值为 100。

1

PageSize

integer

每页显示的条数,默认为 10 条,最大 100 条。

10

DagId

integer

DagId 可以是执行补数据 RunCycleDagNodes ,冒烟测试 RunSmokeTest ,手动业务流程 RunManualDagNodes 等接口返回的 DagId。

11111

Bizdate

string

获取实例列表的日期,格式为 yyyy-MM-dd HH:mm:ss。

2020-02-02 00:00:00

BeginBizdate

string

获取实例列表的开始日期,格式为 yyyy-MM-dd HH:mm:ss。

2020-02-02 00:00:00

EndBizdate

string

获取实例列表的结束日期,格式为 yyyy-MM-dd HH:mm:ss。

2020-02-03 00:00:00

Status

string

任务的状态,取值如下:

  • NOT_RUN(未运行)

  • WAIT_TIME(等待定时间 DueTime 或 CycTime 到来)

  • WAIT_RESOURCE(等待资源)

  • RUNNING(运行中)

  • CHECKING(下发给数据质量进行数据校验)

  • CHECKING_CONDITION(正在进行分支条件校验)

  • FAILURE(执行失败)

  • SUCCESS(执行成功)

NOT_RUN

OrderBy

string

返回值的排序规则。取值如下:

  • CREATE_TIME_DESC:按照创建时间降序返回

  • INSTANCE_ID_DESC:默认值,按照实例 ID 降序返回。

枚举值:

  • CREATE_TIME_DESC :

    按创建时间降序

  • INSTANCE_ID_DESC :

    按实例 ID 降序

INSTANCE_ID_DESC

返回参数

名称

类型

描述

示例值

object

返回结果。

HttpStatusCode

integer

HTTP 状态码。

200

RequestId

string

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

E6F0DBDD-5AD****

ErrorMessage

string

错误信息。

The project does not exist.

ErrorCode

string

错误码。

Invalid.Tenant.ProjectNotExists

Success

boolean

调用是否成功。取值如下:

  • true:调用成功。

  • false:调用失败。

true

Data

object

实例的列表。

PageNumber

integer

页码数。

1

PageSize

integer

每页显示的条数,默认为 10 条,最大为 100 条。

10

TotalCount

integer

实例的总数。

66

Instances

array<object>

实例的信息。

object

返回数据。

Status

string

任务的状态,取值如下:

  • NOT_RUN(1):未运行

  • WAIT_TIME(2): 等待时间。等待定时时间到来

  • WAIT_RESOURCE(3):等待资源。已经下发到执行引擎,在等待资源排队调度执行

  • RUNNING(4):运行中

  • CHECKING(7):校验中。执行完毕,下发给数据质量进行数据校检

  • CHECKING_CONDITION(8): 条件检测中。执行完毕,正在做分支条件校验

  • WAIT_TRIGGER(9):等待触发。触发式节点会在等待时间后变成等待触发

  • FAILURE(5):运行失败

  • SUCCESS(6):运行成功

NOT_RUN

CycTime

integer

调度任务的运行时间。

格式示例为 13 位数字,例如 1590422400000

1590422400000

BeginRunningTime

integer

实例开始运行的时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

FinishTime

integer

调度任务的结束时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

ErrorMessage

string

实例运行的报错信息。

该字段已废弃,您可以调用 GetInstanceLog 接口获取执行任务的相关报错信息。

error message

CreateTime

integer

实例的创建时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

DagId

integer

工作流的 ID。

33845

Priority

integer

实例运行优先级,取值分为 1、3、5、7 和 8。

取值越大,优先级越高。默认优先级为 1。

1

TaskType

string

任务实例的调度类型,取值如下:

  • NORMAL(0):正常调度任务。该任务被日常调度。

  • MANUAL(1):手动任务。该任务不会被日常调度。

  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。

  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。

  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。

  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。

  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。 REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。

NORMAL(0)

ParamValues

string

参数的信息。

bizdate=$bizdate tbods=$tbods

Connection

string

连接串。

odps_source

BaselineId

integer

基线 ID。

123123

DqcType

integer

DQC 类型,取值如下:

  • 0 表示有关联 dqc。

  • 1 表示没有关联 dqc。

1

DagType

string

工作流的类型,取值如下:

  • DAILY(0):日常调度工作流

  • MANUAL(1):手动任务工作流

  • SMOKE_TEST(2):冒烟测试工作流

  • SUPPLY_DATA(3):补数据工作流

  • MANUAL_FLOW(4):手动运行的 dataflow pai 业务流程等(如 IDE 上点击运行业务流程)

  • BUSINESS_PROCESS_DAG(5):手动业务流程工作流

DAILY

BusinessId

integer

业务流程 ID

123

TaskRerunTime

integer

实例还可以运行的次数。取值可以为空、以及大于等于 0 的整数。

  • 取值为空,表示该实例对应的节点没有设置自动重跑次数。

  • 取值为 0,表示该实例不能再重跑。

  • 取值为大于 0 的整数(假设为 n),表示该实例可重跑次数为 n。例如,该参数取值为 1,则剩余重跑次数为 1,取值为 2,则剩余重跑次数为 2,以此类推。初始值为对应节点定义的自动重跑次数+1。

0

ModifyTime

integer

调度任务的最新修改时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

Repeatability

boolean

实例任务是否可以重复执行。

true

RepeatInterval

integer

调度任务运行出错后,重新调整调度频率,单位为毫秒(ms)。

60000

InstanceId

integer

实例的 ID。

1234

BeginWaitResTime

integer

实例任务开始等待资源的时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

RelatedFlowId

integer

关联的业务流程 ID。

123456

Bizdate

integer

执行调度任务的日期。通常为该任务运行时间的前一天。

格式示例为 13 位数字,例如 1590336000000

1590336000000

NodeName

string

节点的名称。

kzh

BeginWaitTimeTime

integer

实例任务开始等待调度的时间。

格式示例为 13 位数字,例如 1590416703313

1590416703313

DqcDescription

string

DQC 分区规则串。

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

NodeId

integer

节点的 ID。

33115

CreateUser

string

触发实例运行的用户。例如,用户 Test 触发补数据实例运行,则 CreateUser 为 Test。

Test

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_source",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情