调用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查看节点ID信息。

Owner String 193379****

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

BizName String test_bizName

业务流程的名称。您可参见ListBusiness查看业务流程信息。

ProgramType String ODPS_SQL

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

PageNumber Integer 1

页码数。

PageSize Integer 10

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

DagId Long 11111

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

返回数据

名称 类型 示例值 描述
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 Integer 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

实例运行错误信息

FinishTime Long 1590416703313

任务的结束时间。

InstanceId Long 1234

实例的ID。

ModifyTime Long 1590416703313

最新修改时间。

NodeId Integer 33115

节点的ID。

NodeName String kzh

节点的名称。

ParamValues String bizdate=$bizdate tbods=$tbods

参数的信息。

Priority Integer 1

实例运行优先级,1/3/5/7/8

RelatedFlowId Long 123456

关联业务流程ID

RepeatInterval Long 60000

出错后重新调度频率,单位为毫秒

Repeatability Boolean true

是否可重复执行

Status String NOT_RUN

任务的状态,包括NOT_RUN(未运行)、WAIT_TIME(等待定时时间dueTime或cycleTime到来)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(下发给数据质量进行数据校检)、CHECKING_CONDITION(正在进行分支条件校检)、FAILURE(执行失败)和SUCCESS(执行成功)。

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
&NodeId=100000000000
&ProjectEnv=PROD
&ProjectId=12345
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

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>
        <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",
            "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
}

错误码

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