调用ListInstances获取实例的列表。

调试

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

请求参数

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

要执行的操作。

RegionId String cn-shanghai

地域信息,通常是服务所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectEnv String PROD

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

ProjectId Long 12345

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

NodeId Long 100000000000

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

NodeName String openmr_8****

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

Owner String 193379****

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

BizName String test_bizName

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

ProgramType String ODPS_SQL

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

PageNumber Integer 1

页码数。最小值1,最大值100

PageSize Integer 10

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

DagId Long 11111

DagId可以是补数据CreateDagComplement,测试CreateTest,执行手动业务流程CreateManualDag等接口返回的DagId。

Bizdate String 2020-02-02 00:00:00

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

BeginBizdate String 2020-02-02 00:00:00

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

EndBizdate String 2020-02-03 00:00:00

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

返回数据

名称 类型 示例值 描述
Data Struct

实例的列表。

Instances Array of Instance

实例的信息。

BaselineId Long 123123

基线ID。

BeginRunningTime Long 1590416703313

实例任务开始运行的时间。

BeginWaitResTime Long 1590416703313

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

BeginWaitTimeTime Long 1590416703313

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

Bizdate Long 1590336000000

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

Connection String odps_first

连接串。

CreateTime Long 1590416703313

实例的创建时间。

CycTime Long 1590422400000

调度任务的运行时间。

DagId Long 33845

工作流的ID。

DagType String DAILY

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

  • DAILY(日常调度)
  • MANUAL(手动任务)
  • SMOKE_TEST(冒烟测试)
  • SUPPLY_DATA(补数据)
DqcDescription String [{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

DQC分区规则串。

DqcType Integer 1

DQC类型,取值如下:

  • 0表示有关联dqc。
  • 1表示没有关联dqc。
ErrorMessage String error message

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

FinishTime Long 1590416703313

调度任务的结束时间。

InstanceId Long 1234

实例的ID。

ModifyTime Long 1590416703313

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

NodeId Long 33115

节点的ID。

NodeName String kzh

节点的名称。

ParamValues String bizdate=$bizdate tbods=$tbods

参数的信息。

Priority Integer 1

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

RelatedFlowId Long 123456

关联的业务流程ID。

RepeatInterval Long 60000

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

Repeatability Boolean true

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

Status String NOT_RUN

任务的状态,取值如下:

  • NOT_RUN(未运行)
  • WAIT_TIME(等待定时时间dueTime或cycleTime到来)
  • WAIT_RESOURCE(等待资源)
  • RUNNING(运行中)
  • CHECKING(下发给数据质量进行数据校检)
  • CHECKING_CONDITION(正在进行分支条件校检)
  • FAILURE(执行失败)
  • SUCCESS(执行成功)
TaskRerunTime Integer 0

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

  • 取值为空,表示该实例对应的节点没有设置重跑次数。
  • 取值为0,表示该实例对应的节点不能再重跑。
  • 取值为大于0的整数(假设为n),表示该实例对应的节点剩余重跑次数为n。例如,该参数取值为1,则剩余重跑次数为1,取值为2,则剩余重跑次数为2,以此类推。
TaskType String NORMAL(0)

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

  • NORMAL(0):正常调度任务。该任务被日常调度。
  • MANUAL(1):手动任务。该任务不会被日常调度。
  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。
  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。
  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。

    REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。

PageNumber Integer 1

页码数。

PageSize Integer 10

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

TotalCount Integer 66

实例的总数。

ErrorCode String Invalid.Tenant.ProjectNotExists

错误码。

ErrorMessage String The project does not exist.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String E6F0DBDD-5AD****

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&RegionId=cn-shanghai
&ProjectEnv=PROD
&ProjectId=12345
&NodeId=100000000000
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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