找不到 API ? 点击 反馈吧
- 标签管理
- 集群管理
- 租户管理
- 租户账号管理
- 数据库管理
- 参数管理
- 会话连接
- 诊断管理
- 安全设置
- 监控管理
- 数据传输
- 创建任务CreateProject
- 启动任务StartProject
- 暂停任务StopProject
- 恢复任务ResumeProject
- 释放任务ReleaseProject
- 删除任务DeleteProject
- 分页查询任务列表ListProjects
- 查询任务的详情DescribeProject
- 查询任务步骤的详情DescribeProjectSteps
- 查询任务步骤的指标DescribeProjectStepMetric
- 查询任务的进度DescribeProjectProgress
- 查询任务的组件信息DescribeProjectComponents
- 查询任务的全量校验结果ListProjectFullVerifyResult
- 启动指定标签下所有未启动的任务StartProjectsByLabel
- 暂停指定标签下所有运行中的任务StopProjectsByLabel
- 获取上传 OSS URLGetUploadOssUrl
- 查询传输实例列表ListWorkerInstances
- 创建 MySQL 数据源CreateMySqlDataSource
- 创建 OceanBase 数据源CreateOceanBaseDataSource
- 查询数据源列表ListDataSource
- 创建标签CreateLabel
- 查询标签列表ListAllLabels
- 新建 MySQL 数据源CreateOmsMysqlDataSource
- 释放传输实例ReleaseWorkerInstance
- 取消修改操作CancelProjectModifyRecord
- 重试修改操作RetryProjectModifyRecords
- 终止修改操作StopProjectModifyRecords
- 查询任务的修改记录ListProjectModifyRecords
- 修改传输对象CreateProjectModifyRecords
- 更新任务配置UpdateProjectConfig
- 删除数据源DeleteDataSource
- 创建 RDS PostgreSQL 数据源CreateRdsPostgreSQLDataSource
- 备份恢复
- 未翻译(其他)
- 其他
CreateProject
本接口用于创建数据迁移或数据同步任务
服务地址：
华东1 金融云
参数配置
高级配置
输入参数
只看必填
UseOss是否使用 OSS 方式创建
请选择布尔值
OssKey通过 GetUploadOssUrl ...
Id数据迁移或数据同步任务的 ID
Name数据迁移或数据同步任务的名称
Type任务的类型
LabelIds标签 ID 的集合
WorkerGradeId传输实例的 ID
SourceEndpointId源端数据源的 ID
SinkEndpointId目标端数据源的 ID
TransferMapping传输对象的映射信息
Mode传输对象映射模式
Databases数据库的信息
0
Id数据库的 ID
Name数据库的名称
MappedName数据库的映射名称
ClusterName映射对象所在的集群
TenantName映射对象所在的租户
Tables当前数据库中传输表对象的配置
0数据库中的表信息
Name表的名称
MappedName表的映射名称
Id表的 ID
WhereClause标准的 SQL 语句中的 WHERE 子句
FilterColumns过滤列集合
ShardColumns分片列集合
AdbTableSchemaADB 数据源的映射信息
ObkvPartitionConfigHBase 模式分区配置
PartitionType分区类型
VirtualColumn虚拟列
PartitionSize分区范围
Views当前数据库中传输视图对象的配置列表
SpecificTables具体表对象的配置集合
DatabasesBlack匹配规则模式：数据库对象黑名单列表
0匹配规则模式：数据库对象黑名单
Id数据库的 ID
Name数据库的名称
MappedName数据库的映射名称
ClusterName映射对象所在的集群
TenantName映射对象所在的租户
Tables当前数据库中传输表对象的配置
Views当前数据库中传输视图对象的配置列表
SpecificTables具体表对象的配置集合
TableAndViewWhiteList匹配规则模式：表和视图的通配白名单列表
TableAndViewBlackList匹配规则模式：表和视图的通配黑名单列表
CommonTransferConfig通用的传输配置
TableCategory支持的表类型
ActiveActive是否为容灾双活场景
请选择布尔值
MqSerializerType投递至消息队列时
MqPartitionMode投递至消息队列时
MqPartition当 MqPartitionMode 为...
DatahubTopicType投递至消息队列 DataHub 时
RocketMqProducerGroup指定生产组名（目标端为 ROCKETM...
RocketMqMsgTags设置消息 tag（目标端为 ROCKE...
RocketMqEnableMsgTrace是否开启消息追踪（目标端为 ROCKE...
请选择布尔值
RocketMqSendMsgTimeout设置消息投递超时时间（目标端为 ROC...
DataWorksBusinessName业务系统标识
SyncSchema是否同步源端数据所在的 Schema ...
请选择布尔值
SyncSchemaColumnName如果开启同步 Schema 到目标端的功能
CustomColumns自定义列数组（目标端需要预先创建对应的列）
SinkStoreFormat目标端表对象存储类型
SourceStoreFormat源端表对象存储类型
EnableStructTransfer是否允许结构传输
请选择布尔值
StructTransferConfig结构传输的配置
ByteCharConvertStrategybyte/char 转换方案
DeferIndexCreation是否允许索引后置
请选择布尔值
EnableFullTransfer是否开启全量传输
请选择布尔值
EnableFullVerify是否开启全量校验
请选择布尔值
FullTransferConfig全量传输的配置
NonePkUkTruncateDstTable处理源端无唯一索引表的全量迁移时
请选择布尔值
AllowDestTableNotEmpty目标端表对象存在记录时处理策略
请选择布尔值
FullTransferSpeedMode全量迁移并发速度
FullVerifySpeedMode全量校验并发速度
WriteWorkerNum写入并发数
ReadWorkerNum读取并发数
ThrottleRps全量传输阶段限制能达到的最大传输速率
ThrottleIOPS全量传输阶段限制能达到的最大传输流量
HbaseObjCheckModeHBase 对象的校验模式
HbaseObjMigModeHBase 对象的迁移模式
IndexDDLConcurrencyLimit单条索引 DDL 并发度配置
MaxConcurrentIndexDDLs最大并发索引 DDL 数量配置
EnableIncrTransfer是否开启增量同步
请选择布尔值
EnableReverseIncrTransfer是否开启反向增量
请选择布尔值
IncrTransferConfig增量同步的配置
StartTimestamp增量同步起始位点
RecordTypeWhiteList有增量同步阶段时
StoreLogKeptHour有增量同步阶段且增量日志拉取组件为 S...
EnableSequencingWithinTxn有增量同步阶段且增量日志拉取组件为 S...
请选择布尔值
IncrSyncConcurrency增量同步的线程数
EnableIncrSyncStatistics是否开启增量记录（DML、DDL）统计
请选择布尔值
ThrottleRps增量传输阶段限制能达到的最大传输速率
ThrottleIOPS增量传输阶段限制能达到的最大传输流量
SupportDDLTypes支持的 DDL 类型
ReverseIncrTransferConfig反向增量传输配置
StartTimestamp反向增量同步起始位点
RecordTypeWhiteList有反向增量同步阶段时
StoreLogKeptHour有反向增量同步阶段
EnableSequencingWithinTxn有反向增量同步阶段
请选择布尔值
IncrSyncConcurrency反向增量同步线程数
EnableIncrSyncStatistics是否开启反向增量记录（DML、DDL）统计
请选择布尔值
ThrottleRps反向增量同步阶段限制能达到的最大传输速率
ThrottleIOPS反向增量同步阶段限制能达到的最大传输流量
SupportDDLTypes支持的 DDL 类型
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
请求参数
| 字段名称 | 字段详情 |
|---|---|
UseOssboolean | 是否使用 OSS 方式创建。 示例值:true |
OssKeystring | 通过 GetUploadOssUrl 获取的 Osskey。 示例值:open_api_create_project/oacp_xxx |
Idstring | 数据迁移或数据同步任务的 ID。您需要调用 ListProjects 接口获取待配置任务的 ID。 示例值:np_fe**** |
Namestring | 数据迁移或数据同步任务的名称。 示例值:test |
Typestring | 任务的类型，包括 示例值:MIGRATION枚举值:MIGRATIONSYNC |
LabelIdsarray<string> | 标签 ID 的集合，最多支持 5 个。 示例值:MIGRATION |
WorkerGradeIdstring | 传输实例的 ID。您需要调用 ListProjects 接口获取待配置任务的 ID。 示例值:g_abcdefj*** |
SourceEndpointIdstring | 源端数据源的 ID。您需要调用 示例值:e_4j0c12z**** |
SinkEndpointIdstring | 目标端数据源的 ID。您需要调用 示例值:e_4j0cz**** |
TransferMappingobject | 传输对象的映射信息。 |
CommonTransferConfigobject | 通用的传输配置。 |
EnableStructTransferboolean | 是否允许结构传输。 示例值:true |
StructTransferConfigobject | 结构传输的配置。 |
EnableFullTransferboolean | 是否开启全量传输。 示例值:true |
EnableFullVerifyboolean | 是否开启全量校验。 示例值:true |
FullTransferConfigobject | 全量传输的配置。 |
EnableIncrTransferboolean | 是否开启增量同步。 示例值:true |
EnableReverseIncrTransferboolean | 是否开启反向增量。 示例值:true |
IncrTransferConfigobject | 增量同步的配置。 |
ReverseIncrTransferConfigobject | 反向增量传输配置。 |
返回参数
| 字段名称 | 字段详情 |
|---|---|
Successboolean | 是否调用成功。 示例值:true |
ErrorDetailobject | 错误详情。 |
Codestring | 错误码（旧）。 示例值:INNER_ERROR |
Messagestring | 错误描述（旧） 示例值:A system error occurred. |
Advicestring | 建议（旧） 示例值:Contact the administrator. |
RequestIdstring | 请求 ID。 示例值:XCVSADG****DSGDS |
PageNumberinteger<int32> | 页序号，分页查询时生效。 示例值:1 |
PageSizeinteger<int32> | 页大小，分页查询时生效。 示例值:10 |
TotalCountinteger<int64> | 总数，分页查询时生效。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:100 |
Coststring | 请求耗时，单位为秒。 示例值:27 |
Datastring | 数据迁移或数据同步任务的 ID。 示例值:np_**** |
变更历史
暂无变更历史