CreateImportMigration - 创建导入迁移

调用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暂无授权信息透出。

请求参数

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

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

123456
Namestring

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

test_import_001
PackageTypestring

导入导出包的类型,取值如下:

  • DATAWORKS_MODEL(标准格式)
  • DATAWORKS_V2(专有云(V3.6.1-V3.11))
  • DATAWORKS_V3(专有云(V3.12 及以上))
DATAWORKS_MODEL
PackageFilestring

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

        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);
/home/admin/xxx/import.zip
ResourceGroupMapstring

调度资源组和数据集成资源组的映射关系。映射的 key 和 value 均为资源组的标识符(identifier), 格式如下:

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

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

{"test_workspace_src": "test_workspace_target"}
CalculateEngineMapstring

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

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

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

  • 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 }
Descriptionstring

导入导出包的描述信息。

test description

返回参数

名称类型描述示例值
object

返回数据。

HttpStatusCodeinteger

HTTP 状态码。

200
Datalong

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

123456
ErrorMessagestring

错误信息。

test error message
RequestIdstring

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

ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
ErrorCodestring

错误码。

110001123456
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-10API 内部配置变更,不影响调用查看变更详情