Queries instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstances

The operation that you want to perform.

RegionId String Yes cn-shanghai

Region information, which is usually the region where the service is located. For example, China (Shanghai) is cn-shanghai, and China (Zhangjiakou) is cn-zhangjiakou. You do not need to specify the RegionId because it is automatically resolved based on the endpoint that is called.

ProjectEnv String Yes PROD

Production environment and development environment.

ProjectId Long Yes 12345

The ID of the DataWorks workspace. You see see ListProjects View the workspace ID.

NodeId Long Yes 100000000000

The ID of the node. You can call ListNodes View the node ID.

NodeName String No openmr_8****

The name of the node. You can call ListNodes View the node ID.

Owner String No 193379****

The ID of the owner. It is the account UID of the workspace administrator. You can log on to the Alibaba Cloud Console and view your account UID on the security page of account management.

BizName String No test_bizName

The name of the workflow. You can see ListBusiness View workflow information.

ProgramType String No ODPS_SQL

The type of the node. You can call ListNodes View the node ID.

PageNumber Integer No 1

The number of the page.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

DagId Long No 11111

A DagId can be used as a CreateDagComplement to perform a retroactive test, a CreateTest test, or a manually triggered workflow CreateManualDag.

Response parameters

Parameter Type Example Description
Data Struct

The list of the instances.

Instances Array of Instance

The information about the instance.

BaselineId Long 123123

The ID of the baseline.

BeginRunningTime Long 1590416703313

The start time of the task.

BeginWaitResTime Long 1590416703313

Time to wait for resources.

BeginWaitTimeTime Long 1590416703313

The time to wait for scheduling.

Bizdate Long 1590336000000

The data timestamp of the node instance.

Connection String odps_first

Connection string mode

CreateTime Long 1590416703313

The time when the instance was created.

CycTime Long 1590422400000

The scheduled time.

DagId Integer 33845

The ID of the workflow.

DagType String DAILY

The type of the workflow. Valid values: DAILY, MANUAL, Smoke testing, and SUPPLY_DATA.

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

DQC partition rule string

DqcType Integer 1

The type of DQC. A value of 0 indicates that a dqc device is associated. A value of 1 indicates that a dqc device is not associated.

ErrorMessage String error message

Instance running errors

FinishTime Long 1590416703313

The end time of the task.

InstanceId Long 1234

The ID of the instance that you want to modify.

ModifyTime Long 1590416703313

The time when the node instance was last modified.

NodeId Integer 33115

The ID of the node.

NodeName String kzh

The name of the node.

ParamValues String bizdate=$bizdate tbods=$tbods

The information about the parameters.

Priority Integer 1

1, 3, 5, 7, and 8, the running priority of an instance

RelatedFlowId Long 123456

Associated workflow ID

RepeatInterval Long 60000

The rescheduling frequency after an error occurs. Unit: milliseconds.

Repeatability Boolean true

Whether it can be executed repeatedly

Status String NOT_RUN

The status of the task, including NOT_RUN (not RUNNING), WAIT_TIME (waiting for the scheduled time dueTime or cycletime come, WAIT_RESOURCE (waiting for a resource), RUNNING (RUNNING), CHECKING (Sent to Data Quality data proof), CHECKING_CONDITION (ongoing branch condition proof), FAILURE (execution fails) and SUCCESS: indicates that the execution is successful.

PageNumber Integer 1

The number of the page.

PageSize Integer 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

TotalCount Integer 66

The total number of instances.

ErrorCode String Invalid.Tenant.ProjectNotExists

The error code.

ErrorMessage String The project does not exist.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String E6F0DBDD-5AD****

The ID of the request. It is used to locate logs and troubleshoot problems.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=ListInstances &NodeId=100000000000 &ProjectEnv=PROD &ProjectId=12345 &RegionId=cn-shanghai &<common request parameters> 
   

Sample success responses

XML format


     <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 Hint


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

Error codes

Go to the Error CenterFor more information, see error codes.