描述
通过这个接口进行数据迁移任务的配置,包括源/目标实例连接信息,迁移对象等。在任务成功启动之前,可以多次调用这个接口进行任务配置的修改。
请求参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
Action | String | 是 | 系统参数,为这个接口的接口定义,取值为:ConfigureMigrationJob |
MigrationJobId | String | 是 | 迁移任务 ID |
MigrationJobName | String | 否 | 迁移任务名称 |
SourceEndpoint.InstanceType | String | 是 | 迁移源实例的实例类型,取值包括:RDS:即 RDS 实例ECS:指 ECS 上的自建数据库LocalInstance:是指本地 IDC 的自建数据库MongoDB:是指阿里云 MongoDB 实例 |
SourceEndpoint.Region | String | 是 | 源实例所在的区域,如果是自建数据库,可以选择离自建 IDC 物理距离最近的区域。取值包括:cn-hangzhou:表示公有云杭州区域cn-shanghai:表示公有云上海区域cn-qingdao:表示公有云青岛区域cn-beijing:表示公有云北京区域cn-zhangbei:表示公有云张北区域cn-shenzhen:表示公有云深圳区域cn-hongkong:表示公有云香港区域us-west-1:表示公有云美西区域us-east-1:表示公有云美东区域ap-southeast-1:表示公有云新加坡区域cn-hangzhou-finance-1:表示金融云杭州区域cn-qingdao-finance-1:表示金融云青岛区域cn-shanghai-finance-1:表示金融云上海区域cn-shenzhen-finance-1:表示金融云深圳区域me-east-1: 表示公有云迪拜区域en-central-1:表示公有云法兰克福区域 |
SourceEndpoint.InstanceId | String | 否 | 源实例 ID当 SourceEndpoint.InstanceType 为 RDS 时,为 RDS 实例 ID当 SourceEndpoint.InstanceType 为 ECS 时,为 ECS 实例 ID当 SouceEndpoint.InstanceType 为 MongoDB 时,为 MongoDB 实例 ID |
SourceEndpoint.EngineName | String | 否 | 源实例的数据库类型,当 SourceEndpoint.InstanceType 为非 RDS 时,为必填项。取值包括:MySQL、SQLServer、PostgreSQL、Oracle、MongoDB、Redis |
SourceEndpoint.IP | String | 否 | 源实例的连接地址,当源实例为自建数据库时必填 |
SourceEndpoint.Port | String | 否 | 源实例的监听端口,当源实例为自建数据库时必填 |
SourceEndpoint.OracleSID | String | 否 | 当源实例数据库类型为 Oracle 时,这个参数为 Oracle SID |
SourceEndpoint.DatabaseName | String | 否 | 当源实例数据库类型为 PostgreSQL 或 MongoDB 时,这个参数为创建连接时使用的数据库库名 |
SourceEndpoint.UserName | String | 是 | 源实例的访问账号 |
SourceEndpoint.Password | String | 是 | 源实例的访问密码 |
SourceEndpoint.OwnerID | String | 是 | 当源实例为 RDS 实例,且源实例跟目标实例所属阿里云账号不同时,这个参数为源 RDS 实例的所属阿里云账号的 UID |
SourceEndpoint.Role | String | 是 | 当源实例为 RDS 实例,且源实例跟目标实例所属阿里云账号不同时,这个参数为源实例所属阿里云账号对目标实例阿里云账号的授权角色。这个角色所需的权限及授权方式详见 跨账号迁移同步 |
DestinationEndpoint.InstanceType | String | 是 | 目标实例的实例类型,取值包括:RDS:即 RDS 实例ECS:指 ECS 上的自建数据库LocalInstance:是指本地 IDC 的自建数据库MongoDB:是指阿里云 MongoDB 实例Redis:是指阿里云 kvstore 实例DRDS:即 DRDS 实例PetaData:即 PetaData 实例OceanBase:即 OceanBase 实例 |
DestinationEndpoint.Region | String | 是 | 目标实例所在区域,如果是自建数据库,可以选择离自建 IDC 物理距离最近的区域。取值包括:cn-hangzhou:表示公有云杭州区域cn-shanghai:表示公有云上海区域cn-qingdao:表示公有云青岛区域cn-beijing:表示公有云北京区域cn-zhangbei:表示公有云张北区域cn-shenzhen:表示公有云深圳区域cn-hongkong:表示公有云香港区域us-west-1:表示公有云美西区域us-east-1:表示公有云美东区域ap-southeast-1:表示公有云新加坡区域cn-hangzhou-finance-1:表示金融云杭州区域cn-qingdao-finance-1:表示金融云青岛区域cn-shanghai-finance-1:表示金融云上海区域cn-shenzhen-finance-1:表示金融云深圳区域me-east-1:表示公有云迪拜区域en-central-1:表示公有云法兰克福区域: |
DestinationEndpoint.InstanceId | String | 否 | 源实例 ID当 DestinationEndpoint.InstanceType 为 RDS 时,为 RDS 实例 ID当 DestinationEndpoint.InstanceType 为 ECS 时,为 ECS 实例 ID当 DestinationEndpoint.InstanceType 为 MongoDB 时,为 MongoDB 实例 ID当 DestinationEndpoint.InstanceType 为 Redis 时,为 Redis 实例 ID当 DestinationEndpoint.InstanceType 为 DRDS 时,为 DRDS 实例 ID当 DestinationEndpoint.InstanceType 为 PetaData 时,为 PetaData 实例 ID当 DestinationEndpoint.InstanceType 为 OceanBase 时,为 OceanBase 实例 ID |
DestinationEndpoint.EngineName | String | 否 | 目标实例的数据类型,当目标实例为自建数据库时必填,取值包括:MySQL,SQL Server,PostgreSQL,PPAS,MongoDB,Redis |
DestinationEndpoint.IP | String | 否 | 目标实例连接地址,当目标实例为本地自建数据库时必填 |
DestinationEndpoint.Port | String | 否 | 目标实例监听端口,当目标实例为自建数据库时必填 |
DestinationEndpoint.DatabaseName | String | 否 | 目标实例的连接数据库库名,如果目标实例的数据库类型为:PostgreSQL、PPAS 或 MongoDB 时,为必填项 |
DestinationEndpoint.UserName | String | 是 | 目标实例的访问账号 |
DestinationEndpoint.Password | String | 是 | 目标实例的访问密码 |
MigrationMode.StructureInitialization | Boolean | 是 | 迁移任务是否进行结构迁移,取值包括:true:表示需要进行结构迁移false:表示不进行结构迁移 |
MigrationMode.DataInitialization | Boolean | 是 | 迁移任务是否进行全量数据迁移,取值包括:true:表示需要进行全量数据迁移false:表示不进行结构迁移 |
MigrationMode.DataSynchronization | Boolean | 是 | 迁移任务是否进行增量数据同步,取值包括:true:表示需要进行增量数据同步false:表示不进行增量数据同步。 |
MigrationObjects | List | 是 | 需要迁移的对象,MigrationObject 的具体定义详见下面的 MigrationObject 参数定义 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。