GetInstance - DataWorks - Alibaba Cloud Documentation Center

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. Set the value to GetInstance.
InstanceId	Long	Yes	1234	The instance ID. You can call the ListInstances operation to obtain the instance ID.
ProjectEnv	String	Yes	PROD	The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	E6F0DBDD-5AD****	The request ID.
ErrorMessage	String	test	The error message returned when the instance fails to be scheduled.
Success	Boolean	true	Indicates whether the request was successful.
ErrorCode	String	0	The error code.
Data	Object		The details of the instance.
Status	String	NOT_RUN	The status of the node that generates the instance. Valid values: NOT_RUN: The node is not run. WAIT_TIME: The node is waiting for the scheduling 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.
CycTime	Long	1590422400000	The scheduling time of the instance.
BeginRunningTime	Long	1590416703313	The time when the instance started to run.
FinishTime	Long	1590416703313	The time when the running of the instance was complete.
CreateTime	Long	1590416703313	The time when the instance was generated.
DagId	Long	338450167	The workflow ID.
Priority	Integer	1	The priority of the instance. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.
TaskType	String	NORMAL(0)	The scheduling type of the node that generates the instance. Valid values: NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node. MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node. PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node. SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to succeeded 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 status of the node to successful when the scheduling system starts to run the node. SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduled time to arrive. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node. CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node. REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.
ParamValues	String	bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif	The parameters related to the node.
Connection	String	odps_source	The connection string.
BaselineId	Long	123123	The baseline ID.
DqcType	Integer	1	Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values: 0: The instance is associated with a monitoring rule in Data Quality. 1: The instance is not associated with a monitoring rule in Data Quality.
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.
BusinessId	Long	123	The workflow ID.
TaskRerunTime	Integer	0	The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0. If the value of this parameter is empty, the number of times that the node can be rerun is not specified. If the value of this parameter is 0, the node cannot be rerun. If the value of this parameter is a positive integer such as n, the node can still be rerun n times. For example, if the value of this parameter is 1, the node can still be rerun once. If the value of this parameter is 2, the node can still be rerun twice.
ModifyTime	Long	1590416703313	The time when the instance was last modified.
Repeatability	Boolean	true	Indicates whether the node that generates the instance can be rerun.
RepeatInterval	Long	60000	The interval at which the node is rerun after the node fails to run. Unit: milliseconds.
InstanceId	Long	11713307578	The instance ID.
BeginWaitResTime	Long	1590416703313	The time when the instance started to wait for resources.
RelatedFlowId	Long	123123	The ID of the workflow to which the node belongs.
Bizdate	Long	1590336000000	The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.
NodeName	String	kzh	The name of the node.
BeginWaitTimeTime	Long	1590416703313	The time when the instance started to wait to be scheduled.
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 node.
NodeId	Long	33115	The node ID.
CreateUser	String	111	The creator of the instance.

Examples

Sample requests

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

Sample success responses

XML format

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

<GetInstanceResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>test</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>0</ErrorCode>
    <Data>
        <Status>NOT_RUN</Status>
        <CycTime>1590422400000</CycTime>
        <BeginRunningTime>1590416703313</BeginRunningTime>
        <FinishTime>1590416703313</FinishTime>
        <CreateTime>1590416703313</CreateTime>
        <DagId>338450167</DagId>
        <Priority>1</Priority>
        <TaskType>NORMAL(0)</TaskType>
        <ParamValues>bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif</ParamValues>
        <Connection>odps_source</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>11713307578</InstanceId>
        <BeginWaitResTime>1590416703313</BeginWaitResTime>
        <RelatedFlowId>123123</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>111</CreateUser>
    </Data>
</GetInstanceResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "E6F0DBDD-5AD****",
  "ErrorMessage" : "test",
  "Success" : true,
  "ErrorCode" : 0,
  "Data" : {
    "Status" : "NOT_RUN",
    "CycTime" : 1590422400000,
    "BeginRunningTime" : 1590416703313,
    "FinishTime" : 1590416703313,
    "CreateTime" : 1590416703313,
    "DagId" : 338450167,
    "Priority" : 1,
    "TaskType" : "NORMAL(0)",
    "ParamValues" : "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection" : "odps_source",
    "BaselineId" : 123123,
    "DqcType" : 1,
    "DagType" : "DAILY",
    "BusinessId" : 123,
    "TaskRerunTime" : 0,
    "ModifyTime" : 1590416703313,
    "Repeatability" : true,
    "RepeatInterval" : 60000,
    "InstanceId" : 11713307578,
    "BeginWaitResTime" : 1590416703313,
    "RelatedFlowId" : 123123,
    "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" : 111
  }
}

Error codes

For a list of error codes, see Service error codes.