Queries the status of a real-time synchronization node or a data synchronization solution.

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 GetDISyncInstanceInfo

The operation that you want to perform. Set the value to GetDISyncInstanceInfo.

ProjectId Long Yes 10000

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to query the workspace ID.

This parameter specifies the DataWorks workspace to which the operation is applied.

TaskType String Yes DI_REALTIME

The type of the object that you want to query. Valid values:

  • DI_REALTIME: real-time synchronization node
  • DI_SOLUTION: data synchronization solution
RegionId String Yes cn-zhangjiakou

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 determines the value of this parameter based on the endpoint that is used to call the operation.

FileId Long Yes 100
  • If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization node that you want to query.
  • If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the data synchronization solution that you want to query.

You can call the ListFiles operation to query the ID of the real-time synchronization node or data synchronization solution.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
RequestId String 0bc1411515937635973****

The ID of the request. You can query logs and troubleshoot issues based on the ID.

Data Object

The status of the real-time synchronization node or data synchronization solution.

Status String RUN
  • If the TaskType parameter is set to DI_REALTIME, the status parameter indicates the status of the real-time synchronization node. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT.
  • If the TaskType parameter is set to DI_SOLITION, the status parameter indicates the status of the data synchronization solution. Valid values: success and fail.
Message String fileId[100] is invalid

The cause of the failure to obtain the status of the real-time synchronization node or data synchronization solution. If the status of the real-time synchronization node or data synchronization solution is obtained, the value null is returned.

Name String streamx_name
  • If the TaskType parameter is set to DI_REALTIME, the name parameter indicates the name of the real-time synchronization node.
  • If the TaskType parameter is set to DI_SOLITION, the value null is returned.
SolutionInfo Object
  • If the TaskType parameter is set to DI_REALTIME, the value null is returned.
  • If the TaskType parameter is set to DI_SOLITION, the SolutionInfo parameter indicates the details of the data synchronization solution.
Status String run

The status of the data synchronization solution.

Id Long 100

The ID of the data synchronization solution.

CreatorName String dataworks_3h1

The creator of the data synchronization solution.

StepDetail Array of StepDetail

The step details of the synchronization solution.

Status String success

The status of the step in the data synchronization solution.

StepId Long 1

The ID of the step in the data synchronization solution.

StepName String Create the base table

The name of the step in the data synchronization solution.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDISyncInstanceInfo
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&<Common request parameters>

Sample success responses

XML format

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

<GetDISyncInstanceInfoResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>RUN</Status>
        <Message>fileId[100] is invalid</Message>
        <Name>streamx_name</Name>
        <SolutionInfo>
            <Status>run</Status>
            <Id>100</Id>
            <CreatorName>dataworks_3h1</CreatorName>
            <StepDetail>
                <Status>success</Status>
                <StepId>1</StepId>
                <StepName>Create the base table</StepName>
            </StepDetail>
        </SolutionInfo>
    </Data>
</GetDISyncInstanceInfoResponse>

JSON format

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

{
  "Success" : true,
  "RequestId" : "0bc1411515937635973****",
  "Data" : {
    "Status" : "RUN",
    "Message" : "fileId[100] is invalid",
    "Name" : "streamx_name",
    "SolutionInfo" : {
      "Status" : "run",
      "Id" : 100,
      "CreatorName" : "dataworks_3h1",
      "StepDetail" : {
        "Status" : "success",
        "StepId" : 1,
        "StepName" : "Create the base table"
      }
    }
  }
}

Error codes

HTTP status code Error code Error message Description
400 Param.Invalid The parameter is invalid. The error message returned because one or more parameters are invalid.
500 InternalError.System An internal error occurred. The error message returned because an internal error has occurred.
403 Forbidden.Access Access is forbidden. The error message returned because you are not authorized to perform this operation.

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