调用ListInstances获取实例的列表_大数据开发治理平台 DataWorks-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListInstances	要执行的操作。
ProjectEnv	String	是	PROD	运行的环境，包括PROD（生产环境）和DEV（开发环境）。
NodeId	Long	是	100000000000	节点的ID。您可以调用ListNodes查看节点ID信息。
NodeName	String	否	openmr_8****	节点的名称。您可以调用ListNodes查看节点名称。
Owner	String	否	193379****	负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。
ProjectId	Long	是	12345	工作空间的ID。您可以调用ListProjects查看空间ID信息。
BizName	String	否	test_bizName	业务流程的名称。您可以调用ListBusiness查看业务流程信息。
ProgramType	String	否	ODPS_SQL	节点的类型。您可以调用ListNodes查看节点类型。
PageNumber	Integer	否	1	页码数，用于翻页。最小值为1，最大值为100。
PageSize	Integer	否	10	每页显示的条数，默认为10条，最大100条。该接口目前不支持指定实例列表的排序方式，实例列表默认按照实例ID降序排序。
DagId	Long	否	11111	DagId可以是执行补数据RunCycleDagNodes，冒烟测试RunSmokeTest，手动业务流程RunManualDagNodes等接口返回的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。
Status	String	否	NOT_RUN	任务的状态，取值如下： NOT_RUN（未运行） WAIT_TIME（等待定时间DueTime或CycTime到来） WAIT_RESOURCE（等待资源） RUNNING（运行中） CHECKING（下发给数据质量进行数据校验） CHECKING_CONDITION（正在进行分支条件校验） FAILURE（执行失败） SUCCESS（执行成功）。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	E6F0DBDD-5AD****	请求的ID。用于定位日志，排查问题。
ErrorMessage	String	The project does not exist.	错误信息。
ErrorCode	String	Invalid.Tenant.ProjectNotExists	错误码。
Success	Boolean	true	调用是否成功。取值如下： true：调用成功。 false：调用失败。
Data	Object		实例的列表。
PageNumber	Integer	1	页码数。
PageSize	Integer	10	每页显示的条数，默认为10条，最大为100条。
TotalCount	Integer	66	实例的总数。
Instances	Array of Instance		实例的信息。
Status	String	NOT_RUN	任务的状态，取值如下： NOT_RUN（未运行） WAIT_TIME（等待定时时间DueTime或CycTime到来） WAIT_RESOURCE（等待资源） RUNNING（运行中） CHECKING（下发给数据质量进行数据校检） CHECKING_CONDITION（正在进行分支条件校检） FAILURE（执行失败） SUCCESS（执行成功）。
CycTime	Long	1590422400000	调度任务的运行时间。
BeginRunningTime	Long	1590416703313	实例开始运行的时间。
FinishTime	Long	1590416703313	调度任务的结束时间。
ErrorMessage	String	error message	实例运行的报错信息。该字段已废弃，您可以调用GetInstanceLog接口获取执行任务的相关报错信息。
CreateTime	Long	1590416703313	实例的创建时间。
DagId	Long	33845	工作流的ID。
Priority	Integer	1	实例运行优先级，取值分为1、3、5、7和8。取值越大，优先级越高。默认优先级为1。
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)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。
ParamValues	String	bizdate=$bizdate tbods=$tbods	参数的信息。
Connection	String	odps_first	连接串。
BaselineId	Long	123123	基线ID。
DqcType	Integer	1	DQC类型，取值如下： 0表示有关联dqc。 1表示没有关联dqc。
DagType	String	DAILY	工作流的类型，取值如下： DAILY（日常调度） MANUAL（手动任务） SMOKE_TEST（冒烟测试） SUPPLY_DATA（补数据）
BusinessId	Long	123	业务流程ID
TaskRerunTime	Integer	0	实例还可以重跑的次数。取值可以为空、以及大于等于0的整数。取值为空，表示该实例对应的节点没有设置重跑次数。取值为0，表示该实例对应的节点不能再重跑。取值为大于0的整数（假设为n），表示该实例对应的节点剩余重跑次数为n。例如，该参数取值为1，则剩余重跑次数为1，取值为2，则剩余重跑次数为2，以此类推。
ModifyTime	Long	1590416703313	调度任务的最新修改时间。
Repeatability	Boolean	true	实例任务是否可以重复执行。
RepeatInterval	Long	60000	调度任务运行出错后，重新调整调度频率，单位为毫秒（ms）。
InstanceId	Long	1234	实例的ID。
BeginWaitResTime	Long	1590416703313	实例任务开始等待资源的时间。
RelatedFlowId	Long	123456	关联的业务流程ID。
Bizdate	Long	1590336000000	执行调度任务的日期。通常为该任务运行时间的前一天。
NodeName	String	kzh	节点的名称。
BeginWaitTimeTime	Long	1590416703313	实例任务开始等待调度的时间。
DqcDescription	String	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]	DQC分区规则串。
NodeId	Long	33115	节点的ID。
CreateUser	String	Test	触发实例运行的用户。例如，用户Test触发补数据实例运行，则CreateUser为Test。

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&ProjectEnv=PROD
&NodeId=100000000000
&NodeName=openmr_8****
&Owner=193379****
&ProjectId=12345
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&DagId=11111
&Bizdate=2020-02-02 00:00:00
&BeginBizdate=2020-02-02 00:00:00
&EndBizdate=2020-02-03 00:00:00
&Status=NOT_RUN
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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_first",
      "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"
    }
  }
}

错误码

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