CreateExportMigration - CreateExportMigration

更新时间:
复制 MD 格式

调用CreateExportMigration接口,新建一个DataWorks的导出任务。该API仅创建导出任务,不会启动执行导出任务。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

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

12345

Name

string

导出任务的名称。

名称必须唯一,即当前 DataWorks 工作空间中不能存在名称重复的导出任务。

test_export_01

ExportMode

string

任务的导出模式,取值如下:

  • FULL:全量导出目标任务。

  • INCREMENTAL:从指定的时间点开始,增量导出目标任务。选择该模式时,需要同时配置 IncrementalSince 参数。

枚举值:

  • FULL :

    全量导出

  • INCREMENTAL :

    增量导出

FULL

IncrementalSince

integer

增量导出目标任务的起始时间。

当 ExportMode 参数配置为 INCREMENTAL 时,IncrementalSince 参数才生效。

1589904000000

ExportObjectStatus

string

导出任务的状态。系统会根据所选状态导出指定状态的任务。取值如下:

  • SAVED:保存状态,即导出已保存的任务。

  • SUBMITTED:提交状态,即导出已提交的任务。

  • DEPLOYED:发布状态,即导出已发布的任务。

枚举值:

  • DEPLOYED :

    发布状态,即导出已发布的任务

  • SAVED :

    保存状态,即导出已保存的任务

  • SUBMITTED :

    提交状态,即导出已提交的任务

SAVED

Description

string

导出任务的描述信息。

test

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

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

34267E2E-0335-1A60-A1F0-ADA530890CBA

Data

integer

导出任务的 ID。

1234

Success

boolean

调用是否成功。取值如下:

  • true:调用成功。

  • false:调用失败,您可以根据请求 ID 定位具体问题。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "34267E2E-0335-1A60-A1F0-ADA530890CBA",
  "Data": 1234,
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情