GetDISyncInstanceInfo获取实时同步任务和同步解决方案任务的运行状态

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetDISyncInstanceInfo	系统规定参数。取值：GetDISyncInstanceInfo。
ProjectId	Long	是	10000	DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间管理页面获取ID。该参数用来确定本次API调用操作使用的DataWorks工作空间。
TaskType	String	是	DI_REALTIME	目标数据源所关联的数据集成同步任务的任务类型。取值如下： DI_REALTIME：表示数据集成实时同步任务。 DI_SOLUTION：表示数据集成同步解决方案。
RegionId	String	是	cn-zhangjiakou	地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
FileId	Long	是	100	当TaskType为DI_REALTIME时，则FileId为实时同步任务的文件ID。当TaskType为DI_SOLUTION时，则FileId为同步解决方案的任务ID。您可以调用ListFiles接口获取任务ID。

返回数据


名称	类型	示例值	描述
Success	Boolean	true	请求是否成功。取值如下： true：成功。 false：失败。
RequestId	String	0bc1411515937635973****	请求ID。用于定位日志，排查问题。
Data	Object		获取同步任务的运行状态。
Status	String	RUN	如果taskType为DI_REALTIME，则status为实时任务的运行状态。包括：PAUSE、NORUN、RUN、KILLING、WAIT。如果taskType为DI_SOLITION，则status为同步解决方案的运行状态。包括：success、fail。
Message	String	fileId[100] is invalid	获取同步任务运行状态失败后的原因描述。如果获取数据集成同步任务成功，则该参数的返回值为空。
Name	String	streamx_name	如果taskType为DI_REALTIME，则name为实时同步任务的名称。如果taskType为DI_SOLITION，则name为空。
SolutionInfo	Object		如果taskType为DI_REALTIME，则SolutionInfo为空。如果taskType为DI_SOLITION，则SolutionInfo为同步解决方案运行详情。
Status	String	run	同步解决方案运行状态。
Id	Long	100	同步解决方案任务ID。
CreatorName	String	dataworks_3h1	同步解决方案任务创建者名称。
StepDetail	Array of StepDetail		同步解决方案任务运行步骤详情。
Status	String	success	同步解决方案运行步骤的状态。
StepId	Long	1	同步解决方案运行步骤的ID。
StepName	String	创建base表	同步解决方案运行步骤的名称。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDISyncInstanceInfo
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&公共请求参数

正常返回示例

XML格式

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>创建base表</StepName>
            </StepDetail>
        </SolutionInfo>
    </Data>
</GetDISyncInstanceInfoResponse>

JSON格式

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" : "创建base表"
      }
    }
  }
}

错误码


HttpCode	错误码	错误信息	描述
400	Param.Invalid	The parameter is invalid.	参数错误
500	InternalError.System	An internal error occurred.	内部报错
403	Forbidden.Access	Access is forbidden.	没有权限

访问错误中心查看更多错误码。