Queries the details of an instance.
Debugging
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 that you want to modify. |
| ProjectEnv | String | Yes | PROD |
The environment of the workspace, including projects in PROD and DEV. |
| 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. |
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 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. |
| Connection | String | odps_first |
Connection string mode |
| 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. |
| 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 instance. |
| InstanceId | Long | 11713307578 |
The ID of the instance that you want to modify. |
| 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. |
| Priority | Integer | 1 |
The priority of the instance. Valid values: 1, 3, 5, 7, and 8. |
| RelatedFlowId | Long | 123123 |
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. |
| ErrorCode | String | 0 |
The error code. |
| ErrorMessage | String | test |
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=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> <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 Hint
{ "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", "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 code
Go to the Error CenterFor more information, see error codes.