调用StopDISyncInstance接口,停止实时同步任务_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	StopDISyncInstance	要执行的操作。
ProjectId	Long	是	10000	DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。该参数用来确定本次API调用操作使用的DataWorks工作空间。
TaskType	String	是	DI_REALTIME	停止数据集成同步任务的任务类型。目前仅支持使用DI_REALTIME类型。 DI_REALTIME代表实时任务。
FileId	Long	是	100	FileId为实时同步任务的ID。您可以调用ListFiles接口获取任务ID。

返回数据

名称	类型	示例值	描述
Success	Boolean	true	请求是否成功。取值如下： true：成功。 false：失败。
RequestId	String	0bc1411515937635973****	请求ID。用于定位日志，排查问题。
Data	Object		停止同步任务的结果。
Status	String	success	停止数据集成同步任务的结果状态。取值如下： success：表示停止数据集成同步任务成功。 fail：表示停止数据集成同步任务失败。
Message	String	fileId:[100] is invalid.	停止数据集成同步任务失败后的原因描述。如果停止数据集成同步任务成功，则该参数的返回值为空。

示例

请求示例

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

正常返回示例

XML格式

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

<StopDISyncInstanceResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>success</Status>
        <Message>fileId:[100] is invalid.</Message>
    </Data>
</StopDISyncInstanceResponse>

JSON格式

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

{
  "Success" : true,
  "RequestId" : "0bc1411515937635973****",
  "Data" : {
    "Status" : "success",
    "Message" : "fileId:[100] is invalid."
  }
}

错误码

HttpCode	错误码	错误信息	描述
400	Param.Invalid	The parameter is invalid.	参数错误
500	InternalError.System	An internal error occurred.	内部报错

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