文档

StartDISyncInstance - 启动实时同步任务和解决方案同步任务

更新时间:

调用StartDISyncInstance接口,启动实时同步任务和解决方案同步任务。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*get
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
TaskTypestring

启动数据集成同步任务的任务类型。 目前仅支持使用 DI_REALTIME 和 DI_SOLUTION 两种类型:

  • DI_REALTIME 代表启动实时任务。
  • DI_SOLUTION 代表启动解决方案。
DI_REALTIME
FileIdlong
  • 当 TaskType 参数配置为 DI_REALTIME,则 FileId 为实时同步任务的任务 ID。
  • 当 TaskType 参数配置为 DI_SOLUTION,则 FileId 为解决方案同步任务的任务 ID。
100
StartParamstring
  • 当 TaskType 参数配置为 DI_REALTIME,则 StartParam 为实时同步任务的启动参数,包括 Failover 的设置,脏数据条数,以及 DDL 的参数配置。
  • 当 TaskType 参数配置为 DI_SOLUTION,则 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"}}

返回参数

名称类型描述示例值
object

返回对象。

Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
RequestIdstring

请求 ID。用于定位日志,排查问题。

0bc1411515937635973****
Dataobject

启动同步任务的结果。

Statusstring

启动同步任务的结果状态。取值如下:

  • success:同步任务启动成功。
  • fail:同步任务启动失败。您可以查看具体原因,处理相关问题。
success
Messagestring

启动数据集成同步任务失败后的原因描述。

如果启动数据集成同步任务成功,则该参数的返回值为空。

fileId:[100] is invalid.

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Param.InvalidThe parameter is invalid.参数错误
403Forbidden.AccessAccess is forbidden.-
500InternalError.SystemAn internal error occurred.内部报错

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