Queries the details of an instance.

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 Required GetInstance

The operation that you want to perform.

InstanceId Long Yes 1234

The ID of the instance.

ProjectEnv String Required PROD

The environment of the workspace, including projects in PROD and DEV.

RegionId String Required 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.

Response parameters

Parameter Type Example Description
Data Struct

The details of the instance.

BeginRunningTime Long 1590416703313

The start time of the instance.

BeginWaitResTime Long 1590416703313

The start time that the instance waited for the specified resources.

BeginWaitTimeTime Long 1590416703313

The time that the instance started to wait for scheduling.

Bizdate Long 1590336000000

The data timestamp of the node instance.

CreateTime Long 1590416703313

The time when the instance was created.

CycTime Long 1590422400000

The scheduled time.

DagId Long 338450167

The ID of the workflow.

DagType String DAILY

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

FinishTime Long 1590416703313

The end time of the instance.

InstanceId Long 11713307578

The ID of the instance.

ModifyTime Long 1590416703313

The time when the node instance was last modified.

NodeId Long 33115

The ID of the node.

NodeName String kzh

The name of the node.

ParamValues String bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif

The parameter information.

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.

ErrorCode String 0

The error code.

ErrorMessage String test

The returned 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 call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetInstance
&InstanceId=1234
&ProjectEnv=PROD
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>E6F0DBDD-5AD****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Status>NOT_RUN</Status>
    <ModifyTime>1590416703313</ModifyTime>
    <InstanceId>11713307578</InstanceId>
    <DagType>DAILY</DagType>
    <NodeName>kzh</NodeName>
    <ParamValues>bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif</ParamValues>
    <CreateTime>1590416703313</CreateTime>
    <CycTime>1590422400000</CycTime>
    <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
    <DagId>1234</DagId>
    <Bizdate>1590336000000</Bizdate>
    <BeginRunningTime>1590416703313</BeginRunningTime>
    <FinishTime>1590416703313</FinishTime>
    <NodeId>1234</NodeId>
    <BeginWaitResTime>1590416703313</BeginWaitResTime>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>test</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "E6F0DBDD-5AD****",
    "HttpStatusCode": 200,
    "Data": {
        "Status": "NOT_RUN",
        "ModifyTime": 1590416703313,
        "InstanceId": 11713307578,
        "DagType": "DAILY",
        "NodeName": "kzh",
        "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
        "CreateTime": 1590416703313,
        "CycTime": 1590422400000,
        "BeginWaitTimeTime": 1590416703313,
        "DagId": 1234,
        "Bizdate": 1590336000000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "NodeId": 1234,
        "BeginWaitResTime": 1590416703313
    },
    "ErrorCode": 0,
    "ErrorMessage": "test",
    "Success": true
}

Error code

For a list of error codes, visit the API Error Center.