DeployDISyncTask - 部署发布同步任务

更新时间:
复制 MD 格式

该接口用于发布实时同步任务。

接口说明

调用时需指定目标 DataWorks 工作空间所在地域。RegionId 是用于选择地域端点的主机级参数,例如 cn-hangzhou 对应杭州地域端点。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

是

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000

TaskType

string

是

目标数据源所关联的数据集成同步任务的任务类型。取值如下:

  • DI_REALTIME:表示数据集成实时同步任务。

  • DI_SOLUTION:表示数据集成主站同步任务。

DI_REALTIME

FileId

integer

是

  • 当 TaskType 为 DI_REALTIME 时,则 FileId 为实时同步任务的文件 ID。

  • 当 TaskType 为 DI_SOLUTION 时,则 FileId 为主站同步任务的任务 ID。

您可以调用 ListFiles 接口获取任务 ID。

100

返回参数

名称

类型

描述

示例值

object

数据集成同步任务返回结果。

Success

boolean

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

  • true:成功。

  • false:失败。

true

RequestId

string

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

0bc14115159376359******

Data

object

发布同步任务的结果。

Status

string

发布数据集成同步任务的结果状态。取值如下:

  • success:表示发布数据集成同步任务成功。

  • fail:表示发布数据集成同步任务失败。

success

Message

string

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

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

submit and deploy fail.

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0bc14115159376359******",
  "Data": {
    "Status": "success",
    "Message": "submit and deploy fail."
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Param.Invalid The parameter is invalid. 参数错误
500 InternalError.System An internal error occurred. 内部报错
403 Forbidden.Access Access is forbidden.

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

变更历史

更多信息,参考变更详情。