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

The operation that you want to perform.

InstanceId Long Yes 1234

The ID of the instance. You can call the ListInstances operation to query the ID.

ProjectEnv String Yes PROD

The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Response parameters

Parameter Type Example Description
Data Struct

The details of the instance.

BaselineId Long 123123

The ID of the baseline.

BeginRunningTime Long 1590416703313

The time when the instance started to run.

BeginWaitResTime Long 1590416703313

The time when the instance started to wait for resources.

BeginWaitTimeTime Long 1590416703313

The time when the instance started to wait for its scheduled time to arrive.

Bizdate Long 1590336000000

The data timestamp. In most cases, the value is one day before the date when the instance is run.

Connection String odps_first

The connection string.

CreateTime Long 1590416703313

The time when the instance was created.

CycTime Long 1590422400000

The time when the instance was scheduled to run.

DagId Long 338450167

The ID of the workflow.

DagType String DAILY

The type of the workflow. Valid values:

  • DAILY: The workflow is used to run auto triggered nodes.
  • MANUAL: The workflow is used to run manually triggered nodes.
  • SMOKE_TEST: The workflow is used to perform smoke testing.
  • SUPPLY_DATA: The workflow is used to backfill data.
DqcDescription String [{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

The table and partition filter expression in Data Quality that are associated with the instance.

DqcType Integer 1

Indicates whether the instance is associated with Data Quality. Valid values:

  • 0: The instance is associated with Data Quality.
  • 1: The instance is not associated with Data Quality.
FinishTime Long 1590416703313

The time when the running of the instance was complete.

InstanceId Long 11713307578

The ID of the instance.

ModifyTime Long 1590416703313

The time when the 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 values of the parameters related to the node.

Priority Integer 1

The priority of the instance. Valid values: 1, 3, 5, 7, and 8. A large value indicates a high priority. Default value: 1.

RelatedFlowId Long 123123

The ID of the associated workflow.

RepeatInterval Long 60000

The interval at which the node is rerun after the node fails to run. Unit: milliseconds.

Repeatability Boolean true

Indicates whether the node can be rerun.

Status String NOT_RUN

The status of the node. Valid values:

  • NOT_RUN: The node is not run.
  • WAIT_TIME: The node is waiting for its scheduled time to arrive.
  • WAIT_RESOURCE: The node is waiting for resources.
  • RUNNING: The node is running.
  • CHECKING: Data quality is being checked for the node.
  • CHECKING_CONDITION: Branch conditions are being checked for the node.
  • FAILURE: The node fails to run.
  • SUCCESS: The node is successfully run.
TaskRerunTime Integer 0

The number of times the node can be rerun. This parameter can be left empty, or the value of this parameter can be an integer that is greater than or equal to 0.

  • If this parameter is left empty, the number of rerun times is not specified for the node.
  • If the value of this parameter is set to 0, the node cannot be rerun.
  • If the value of this parameter is n (an integer that is greater than 0), the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun one time. If the value of this parameter is 2, the node can be rerun two times, and so on.
TaskType String NORMAL(0)

The scheduling type of the node. Valid values:

  • NORMAL(0): The node is an auto triggered node. It is run on a regular basis.
  • MANUAL(1): The node is a manually triggered node. It is not run on a regular basis.
  • PAUSE(2): The node is a frozen node. The scheduling system still runs the node but sets it to FAILURE when the scheduling system starts to run the node.
  • SKIP(3): The node is a dry-run node. The scheduling system still runs the node but sets it to SUCCESS when the scheduling system starts to run the node.
  • SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the node to SUCCESS when the scheduling system starts to run the node.
  • SKIP_CYCLE(5): The node is a weekly or monthly node whose running cycle does not arrive. The scheduling system still runs the node but sets it to SUCCESS when the scheduling system starts to run the node.
  • CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is set to a dry-run node.
  • REALTIME_DEPRECATED(7): The node is generated in real time but is deprecated. The scheduling system directly sets it to SUCCESS.
ErrorCode String 0

The error code returned.

ErrorMessage String test

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String E6F0DBDD-5AD****

The ID of the request. You can use the ID to locate logs and troubleshoot issues.

Success Boolean true

Indicates whether the request 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>
    <BaselineId>123123</BaselineId>
    <ModifyTime>1590416703313</ModifyTime>
    <NodeName>kzh</NodeName>
    <DagType>DAILY</DagType>
    <ParamValues>bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif</ParamValues>
    <DagId>338450167</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>
    <TaskRetunTime>0</TaskRetunTime>
    <InstanceId>11713307578</InstanceId>
    <DqcType>1</DqcType>
    <Priority>1</Priority>
    <CreateTime>1590416703313</CreateTime>
    <Connection>odps_first</Connection>
    <RelatedFlowId>123123</RelatedFlowId>
    <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
    <CycTime>1590422400000</CycTime>
    <Repeatability>true</Repeatability>
    <NodeId>33115</NodeId>
    <BeginWaitResTime>1590416703313</BeginWaitResTime>
    <ErrorMessage>error message</ErrorMessage>
    <RepeatInterval>60000</RepeatInterval>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>test</ErrorMessage>
<Success>true</Success>

JSON format 

{
    "RequestId": "E6F0DBDD-5AD****",
    "HttpStatusCode": 200,
    "Data": {
        "BaselineId": 123123,
        "ModifyTime": 1590416703313,
        "NodeName": "kzh",
        "DagType": "DAILY",
        "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
        "DagId": 338450167,
        "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)",
        "TaskRetunTime": 0,
        "InstanceId": 11713307578,
        "DqcType": 1,
        "Priority": 1,
        "CreateTime": 1590416703313,
        "Connection": "odps_first",
        "RelatedFlowId": 123123,
        "BeginWaitTimeTime": 1590416703313,
        "CycTime": 1590422400000,
        "Repeatability": true,
        "NodeId": 33115,
        "BeginWaitResTime": 1590416703313,
        "ErrorMessage": "error message",
        "RepeatInterval": 60000
    },
    "ErrorCode": 0,
    "ErrorMessage": "test",
    "Success": true
}

Error codes

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