备案控制台
文档
产品文档
输入文档关键字查找
首页 大数据开发治理平台 DataWorks 开发参考 API参考 迁移助手 CreateImportMigration

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代码示例。

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 CreateImportMigration

系统规定参数。取值：CreateImportMigration。
ProjectId Long 是 123456

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

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

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

  • DATAWORKS_MODEL（标准格式）
  • DATAWORKS_V2（专有云（V3.6.1-V3.11））
  • DATAWORKS_V3（专有云（V3.12及以上））
PackageFile String 是 /home/admin/xxx/import.zip

导入包文件路径。

注意：本接口导入文件涉及文件上传。方式调用举例如下： 
java
        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);
ResourceGroupMap String 否 {"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}

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

json
{
    "SCHEDULER_RESOURCE_GROUP": {
        "xxx": "yyy"
    },
    "DI_RESOURCE_GROUP": {
        "ccc": "dfdd"
    }
}
WorkspaceMap String 否 {"test_workspace_src": "test_workspace_target"}

用于在执行导入导出操作时，根据该映射关系，修改导入导出包里的输入输出项目空间名称为映射后的项目空间名称。例如，导入时会根据映射关系，把输入输出里的项目空间名称的前缀做相应替换。
CalculateEngineMap String 是 { "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }

导入任务中，导入的源计算引擎到导出的目标计算引擎实例的映射关系。

计算引擎的类型，包括ODPS、EMR、HADOOP_CDH、HOLOGRES等。
CommitRule String 是 { "resourceAutoCommit": false, "resourceAutoDeploy": false, "functionAutoCommit": false, "functionAutoDeploy": false, "tableAutoCommitToDev": false, "tableAutoCommitToProd": false, "ignoreLock": false, "fileAutoCommit": false, "fileAutoDeploy": false }

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

  • 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表示否。
Description String 否 test description

导入导出包的描述信息。

返回数据

名称

类型

示例值

描述
HttpStatusCode Integer 200

HTTP状态码。
Data Long 123456

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

错误信息。
RequestId String ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS

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

错误码。
Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateImportMigration
&ProjectId=123456
&Name=test_import_001
&PackageType=DATAWORKS_MODEL
&PackageFile=/home/admin/xxx/import.zip
&ResourceGroupMap={"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}
&WorkspaceMap={"test_workspace_src": "test_workspace_target"}
&CalculateEngineMap={     "ODPS": {       "zxy_8221431_engine": "wzp_kaifazheban_engine"     },     "EMR": {         "aaaa": "bbb"     }   }
&CommitRule={     "resourceAutoCommit": false,     "resourceAutoDeploy": false,     "functionAutoCommit": false,     "functionAutoDeploy": false,     "tableAutoCommitToDev": false,     "tableAutoCommitToProd": false,     "ignoreLock": false,     "fileAutoCommit": false,     "fileAutoDeploy": false   }
&Description=test description
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateImportMigrationResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>123456</Data>
    <ErrorMessage>test error message</ErrorMessage>
    <RequestId>ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS</RequestId>
    <ErrorCode>110001123456</ErrorCode>
    <Success>true</Success>
</CreateImportMigrationResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

文档推荐
  • 本页导读 （1）
文档反馈