调用StartDISyncInstance接口,启动实时同步任务和解决方案同步任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartDISyncInstance |
要执行的操作。 |
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 |
|
StartParam | String | 否 | {"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}} |
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Success | Boolean | true |
请求是否成功。取值如下:
|
RequestId | String | 0bc1411515937635973**** |
请求ID。用于定位日志,排查问题。 |
Data | Object |
启动同步任务的结果。 |
|
Status | String | success |
启动同步任务的结果状态。取值如下:
|
Message | String | fileId:[100] is invalid. |
启动数据集成同步任务失败后的原因描述。 如果启动数据集成同步任务成功,则该参数的返回值为空。 |
示例
请求示例
http(s)://[Endpoint]/?Action=StartDISyncInstance
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&StartParam={"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<StartDISyncInstanceResponse>
<RequestId>0bc1411515937635973****</RequestId>
<Data>
<Status>success</Status>
<Message>fileId:[100] is invalid.</Message>
</Data>
<Success>true</Success>
</StartDISyncInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "0bc1411515937635973****",
"Data" : {
"Status" : "success",
"Message" : "fileId:[100] is invalid."
},
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Param.Invalid | The parameter is invalid. | 参数错误 |
500 | InternalError.System | An internal error occurred. | 内部报错 |
403 | Forbidden.Access | Access is forbidden. | 没有权限 |
访问错误中心查看更多错误码。