文档

DeployDISyncTask - 部署发布同步任务

更新时间:

发布实时同步任务和同步解决方案任务。

调试

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

授权信息

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

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

请求参数

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

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

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

10000
TaskTypestring

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

  • DI_REALTIME:表示数据集成实时同步任务。
  • DI_SOLUTION:表示数据集成同步解决方案。
DI_REALTIME
FileIdlong
  • 当 TaskType 为 DI_REALTIME 时,则 FileId 为实时同步任务的文件 ID。
  • 当 TaskType 为 DI_SOLUTION 时,则 FileId 为同步解决方案的任务 ID。

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

100

返回参数

名称类型描述示例值
object

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

Successboolean

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

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

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

0bc1411515937635973****
Dataobject

发布同步任务的结果。

Statusstring

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

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

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

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

submit and deploy fail.

示例

正常返回示例

JSON格式

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

错误码

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

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

  • 本页导读 (1)