AI 助理
文档备案控制台
官方文档
首页 大数据开发治理平台 DataWorks 开发参考 API参考（2020-05-18） API目录 迁移助手 CreateImportMigration - CreateImportMigration

CreateImportMigration - CreateImportMigration

更新时间：
复制 MD 格式
产品详情
我的收藏

调用CreateImportMigration接口创建导入任务，导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。

接口说明

注意：本接口导入文件涉及文件上传，方式调用举例如下：

    Config config = new Config();
    config.setAccessKeyId(accessId);
    config.setAccessKeySecret(accessKey);
    config.setEndpoint(popEndpoint);
    config.setRegionId(regionId);
    
    Client client = new Client(config);

    CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();
    request.setName("test_migration_api_" + System.currentTimeMillis());
    request.setProjectId(123456L); 
    request.setPackageType("DATAWORKS_MODEL");
    request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));

    RuntimeOptions runtime = new RuntimeOptions();
    CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);
    ...

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

update

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ProjectId

integer

是

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

123456
Name

string

是

创建的导入任务的名称。项目空间内该名称必须唯一。

test_import_001
PackageType

string

是

导入导出包的类型，取值如下：

  • DATAWORKS_MODEL（标准格式）

  • DATAWORKS_V2（专有云（V3.6.1-V3.11））

  • DATAWORKS_V3（专有云（V3.12 及以上））

DATAWORKS_MODEL
PackageFile

string

是

导入包文件路径。 注意：本接口导入文件涉及文件上传。方式调用举例如下：

        Config config = new Config();
        config.setAccessKeyId(accessId);
        config.setAccessKeySecret(accessKey);
        config.setEndpoint(popEndpoint);
        config.setRegionId(regionId);

        Client client = new Client(config);

        CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();
        request.setName("test_migration_api_" + System.currentTimeMillis());
        request.setProjectId(123456L); 
        request.setPackageType("DATAWORKS_MODEL");
        request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));

        RuntimeOptions runtime = new RuntimeOptions();
        CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);

直接传递文件地址时，参数值必须是调用者账号下 OSS 对象的有效 URL，例如 https://{bucket}.oss-{region}.aliyuncs.com/{object_key}；跨账号 OSS URL 会被拒绝。使用 SDK Advance 方法时，可通过本地文件流完成上传。

/home/admin/xxx/import.zip
ResourceGroupMap

string

否

调度资源组和数据集成资源组的映射关系。映射的 key 和 value 均为资源组的标识符（identifier）， 格式如下：

{
    "SCHEDULER_RESOURCE_GROUP": {
        "xxx": "yyy"
    },
    "DI_RESOURCE_GROUP": {
        "ccc": "dfdd"
    }
}

{"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}
WorkspaceMap

string

否

用于在执行导入导出操作时，根据该映射关系，修改导入导出包里的输入输出项目空间名称为映射后的项目空间名称。例如，导入时会根据映射关系，把输入输出里的项目空间名称的前缀做相应替换。

{"test_workspace_src": "test_workspace_target"}
CalculateEngineMap

string

否

导入任务中，导入的源计算引擎到导出的目标计算引擎实例的映射关系。 计算引擎的类型，包括 ODPS、EMR、HADOOP_CDH、HOLOGRES 等。

{ "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }
CommitRule

string

否

执行导入操作时，设定的自动提交发布任务的规则。参数如下：

  • resourceAutoCommit：资源是否自动提交。true 表示是，false 表示否。

  • resourceAutoDeploy：资源是否自动发布。true 表示是，false 表示否。

  • functionAutoCommit：函数是否自动提交。true 表示是，false 表示否。

  • functionAutoDeploy： 函数是否自动发布。true 表示是，false 表示否。

  • tableAutoCommitToDev：表是否自动提交到开发环境。true 表示是，false 表示否。

  • tableAutoCommitToProd：表是否自动提交到生产环境。true 表示是，false 表示否。

  • ignoreLock：是否自动绕过锁定。true 表示是，false 表示否。当任务被其他人编辑锁定时，如果选择绕过锁定，则可以强制更新当前任务。

  • fileAutoCommit：文件是否自动提交，true 表示是，false 表示否。

  • fileAutoDeploy：文件是否自动发布，true 表示是，false 表示否。

{ "resourceAutoCommit": false, "resourceAutoDeploy": false, "functionAutoCommit": false, "functionAutoDeploy": false, "tableAutoCommitToDev": false, "tableAutoCommitToProd": false, "ignoreLock": false, "fileAutoCommit": false, "fileAutoDeploy": false }
Description

string

否

导入导出包的描述信息。

test description

返回参数

名称

类型

描述

示例值

object

返回数据。

HttpStatusCode

integer

HTTP 状态码。

200
Data

integer

导入导出包 ID。作为后续执行导入任务或获取导入任务执行进度的入参。

123456
ErrorMessage

string

错误信息。

test error message
RequestId

string

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

ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
ErrorCode

string

错误码。

110001123456
Success

boolean

调用是否成功。

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 123456,
  "ErrorMessage": "test error message",
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "ErrorCode": "110001123456",
  "Success": true
}

错误码

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

变更历史

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

上一篇：迁移助手下一篇：GetMigrationProcess - 获取迁移过程