CreateProject - 创建任务 - 云数据库 OceanBase

本接口用于创建数据迁移或数据同步任务。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
UseOss	boolean	否	是否使用 OSS 方式创建。	true
OssKey	string	否	通过 GetUploadOssUrl 获取的 Osskey。	open_api_create_project/oacp_xxx
Id	string	是	数据迁移或数据同步项目的 ID。	np_fe****
Name	string	是	数据迁移或数据同步项目的名称。	test
Type	string	是	项目的类型，包括 `MIGRATION`（表示数据迁移项目）和 `SYNC`（表示数据同步项目）。	MIGRATION
LabelIds	array	否	标签 ID 的集合，最多支持 5 个。
	string	否	标签 ID。	I_dfe****
WorkerGradeId	string	是	传输实例的 ID。	g_abcdefj***
SourceEndpointId	string	是	源端数据源的 ID。您需要调用 `ListDataSource` 接口获取 ID，格式为 e_****。	e_4j0c12z****
SinkEndpointId	string	是	目标端数据源的 ID。您需要调用 `ListDataSource` 接口获取 ID，格式为 e_****。	e_4j0cz****
TransferMapping	object	是	传输对象的映射信息。
Mode	string	否	传输对象映射模式，包括 `SPECIFIC`（表示指定对象）和 `WILDCARD`（表示匹配规则）。	SPCEIFIC
Databases	array<object>	否	数据库的信息。
	object	否
Id	string	否	数据库的 ID。	gez3***
Name	string	否	数据库的名称。	db_name
MappedName	string	否	数据库的映射名称。	mapped_db
ClusterName	string	否	映射对象所在的集群，源端为 OceanBase 数据源时生效。注意该参数已废弃。	cluster_name
TenantName	string	否	映射对象所在的租户，源端为 OceanBase 数据源时生效。注意该参数已废弃。	tenant_name
Tables	array<object>	否	当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。
	object	否	数据库中的表信息。
Name	string	否	表的名称。	table_name
MappedName	string	否	表的映射名称。	mapped_table
Id	string	否	表的 ID。	e_4l085bu7***
WhereClause	string	否	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id > 1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk_col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
Views	array<object>	否	当前数据库中传输视图对象的配置列表。
	object	否	当前数据库中传输视图对象的配置列表。
Name	string	否	视图的名称。	view_name
MappedName	string	否	视图的映射名称。	mapped_view
Id	string	否	视图的 ID。	e_4himpq4z***
WhereClause	string	否	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk_col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
SpecificTables	array<object>	否	具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。
	object	否
Name	string	否	表的名称。	table_name
MappedName	string	否	表的映射名称。	mapped_table
Id	string	否	表的 ID。	e_4azdil4lu7***
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<5
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk_col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
SpecificViews	array<object>	否	具体视图对象的配置。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。
	object	否	具体视图对象的配置。mode 为 WILDCARD 时，该参数表示具体视图对象的重命名配置。
Name	string	否	视图的名称。	view_name
MappedName	string	否	视图的映射名称。	mapped_view
Id	string	否	视图的 ID。	e_3wsmjv49a***
WhereClause	string	否	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<5
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk_col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
DatabasesBlack	array<object>	否	匹配规则模式：数据库对象黑名单列表。
	object	否	匹配规则模式：数据库对象黑名单。
Id	string	否	数据库的 ID。	e_3y6v5v1x94f4
Name	string	否	数据库的名称。	db_name
MappedName	string	否	数据库的映射名称。	mapped_db
ClusterName	string	否	映射对象所在的集群，源端为 OceanBase 数据源时生效。注意该参数已废弃。	cluster_name
TenantName	string	否	映射对象所在的租户，源端为 OceanBase 数据源时生效。注意该参数已废弃。	tenant_name
Tables	array<object>	否	当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。
	object	否	当前数据库中传输表对象的配置。
Name	string	否	表的名称。	table_name
MappedName	string	否	表的映射名称。	mapped_table
Id	string	否	表的 ID。	e_474hmh5iqo***
WhereClause	string	否	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
Views	array<object>	否	当前数据库中传输视图对象的配置列表。
	object	否	当前数据库中传输视图对象的配置列表。
Name	string	否	视图的名称。	view_name
MappedName	string	否	视图的映射名称。	mapped_view
Id	string	否	视图的 ID。	e_4azdil4lu7mo
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<5
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk_col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
SpecificTables	array<object>	否	具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。
	object	否
Name	string	否	表的名称。	table_name
Id	string	否	表的 ID。	e_4himpq4zf***
MappedName	string	否	表的映射名称。	mapped_table
WhereClause	string	否	标准的 SQL 语句中的 WHERE 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
SpecificViews	array<object>	否	具体视图对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。
	object	否
Name	string	否	表的名称。	table_name
MappedName	string	否	表的映射名称。	mapped_table
Id	string	否	视图的 ID。	e_474hmh5iqo***
WhereClause	string	否	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片列集合。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	col
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
TableAndViewWhiteList	array	否	匹配规则模式：表和视图的通配白名单列表。
	string	否	匹配规则模式：表和视图的通配白名单。	null
TableAndViewBlackList	array	否	匹配规则模式：表和视图的通配黑名单列表。
	string	否	匹配规则模式：表和视图的通配黑名单。	null
CommonTransferConfig	object	否	通用的传输配置。
TableCategory	string	否	支持的表类型。包括 ALL（所有表）、WITH_UNIQUE_ROW_ID（有唯一行标识的表）和 WITHOUT_UNIQUE_ROW_ID（无唯一行标识的表），默认值为 ALL。	ALL
ActiveActive	boolean	否	是否为容灾双活场景。	false
MqSerializerType	string	否	投递至消息队列时，数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、DEBEZIUM、DEBEZIUMFlatten 和 DEBEZIUMSMT。	DEFAULT
MqPartitionMode	string	否	投递至消息队列时，分区路由方式。包括 ONE（指定分区投递）、HASH（根据主键/分片列值进行 HASH 分区投递、TABLE（根据库表名进行 HASH 分区投递）。	ONE
MqPartition	integer	否	当 `partitionMode` 为 `ONE` 时，该参数表示投递的分区在当前 Topic 下的位置。	0
DatahubTopicType	string	否	投递至消息队列 DataHub 时，指定 Topic 的类型。枚举值： BLOB：BLOB。 TUPLE：TUPLE。	TUPLE
RocketMqProducerGroup	string	否	指定生产组名（目标端为 ROCKETMQ 时生效），默认值为 OMS。	OMS
RocketMqMsgTags	string	否	设置消息 tag（目标端为 ROCKETMQ 时生效），默认 default->default_tag。	default_tag
RocketMqEnableMsgTrace	boolean	否	是否开启消息追踪（目标端为 ROCKETMQ 时生效）。	false
RocketMqSendMsgTimeout	long	否	设置消息投递超时时间（目标端为 ROCKETMQ 时生效）。	null
DataWorksBusinessName	string	否	业务系统标识。	null
SyncSchema	boolean	否	是否同步源端数据所在的 Schema 到目标端（预期目标端表上会创建一个附加列，用于接收 Schema 名称，该字段见 `syncSchemaColumnName` 参数）。	true
SyncSchemaColumnName	string	否	如果开启同步 Schema 到目标端的功能，您可以指定同步到目标端的列名（需要在目标端预先创建该列）。	source_schema_name
CustomColumns	array<object>	否	自定义列数组（目标端需要预先创建对应的列）。
	object	否
ColumnName	string	否	列的名称。	test_column
Expression	string	否	列值表达式。	test
EnableStructTransfer	boolean	否	是否允许结构传输。	true
StructTransferConfig	object	否	结构传输的配置。
ByteCharConvertStrategy	string	否	byte/char 转换方案，默认值为 `DO_NOTHING_IF_BYTE_USED`。	DO_NOTHING_IF_BYTE_USED
DeferIndexCreation	boolean	否	是否允许索引后置。	true
EnableFullTransfer	boolean	否	是否开启全量传输。	true
EnableFullVerify	boolean	否	是否开启全量校验。	true
FullTransferConfig	object	否	全量传输的配置。
NonePkUkTruncateDstTable	boolean	否	处理源端无唯一索引表的全量迁移时，是否清空目标表。场景：PolarDB-X 1.0 数据库多链路无主键表汇聚至同一目标端表，避免前面若干条链路有部分数据后，另一条链路刚启动便清空了历史的迁移数据。	true
AllowDestTableNotEmpty	boolean	否	目标端表对象存在记录时处理策略，包括忽略和停止迁移。设置为 true，表示选择忽略：当目标端表对象存在数据时，如果原数据与写入数据冲突，数据传输采用将冲突数据记录日志，保留原数据不变的策略进行数据写入。注意选择忽略，全量校验将使用 IN 模式拉取数据，无法校验目标端多数据的场景，并且校验性能存在一定程度降级。设置为 false，表示选择停止迁移：当目标端表对象存在数据时，全量迁移会报错不允许迁移，请处理好目标端数据后再继续迁移。注意如果出错后单击恢复，数据传输将忽略该配置选项，继续迁移表数据，请谨慎操作。	true
FullTransferSpeedMode	string	否	全量迁移并发速度，包括 STEADY、NORMAL 和 FAST。注意如果有全量迁移步骤，则 FullTransferSpeedMode 必传，可以传 NORMAL。	NORMAL
FullVerifySpeedMode	string	否	全量校验并发速度，包括 STEADY、NORMAL 和 FAST。注意如果有全量校验步骤，则 FullVerifySpeedMode 必传，可以传 NORMAL。	NORMAL
WriteWorkerNum	integer	否	写入并发数。	64
ReadWorkerNum	integer	否	读取并发数。	64
ThrottleRps	integer	否	全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。	null
ThrottleIOPS	integer	否	全量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。	null
EnableIncrTransfer	boolean	否	是否开启增量同步。	true
EnableReverseIncrTransfer	boolean	否	是否开启反向增量。	true
IncrTransferConfig	object	否	增量同步的配置。
StartTimestamp	string	否	增量同步起始位点。仅启用增量同步但未启用全量传输时，支持设置该参数。	1689201369
RecordTypeWhiteList	array	否	有增量同步阶段时，同步的增量数据类型。
	string	否	有增量同步阶段时，同步的增量数据类型。	INSERT
StoreLogKeptHour	integer	否	有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。	24
EnableSequencingWithinTxn	boolean	否	有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。	true
IncrSyncConcurrency	integer	否	增量同步的线程数，默认值为 64。	64
EnableIncrSyncStatistics	boolean	否	是否开启增量记录（DML、DDL）统计。	true
ThrottleRps	integer	否	增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。	null
ThrottleIOPS	integer	否	增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。	null
SupportDDLTypes	array	否	支持的 DDL 类型。
SupportDDLType	string	否	支持的 DDL 类型。	CREATE_TABLE
ReverseIncrTransferConfig	object	否	反向增量传输配置。
StartTimestamp	string	否	反向增量同步位点。	1684771200
RecordTypeWhiteList	array	否	有反向增量同步阶段时，同步的增量数据类型。
	string	否	有反向增量同步阶段时，同步的增量数据类型。	INSERT
StoreLogKeptHour	integer	否	有反向增量同步阶段，且增量日志拉取组件为 Store 时的日志保存时间，单位为小时。默认 7 天，最长 365 天。	24
EnableSequencingWithinTxn	boolean	否	有反向增量同步阶段，且增量日志拉取组件为 Store 时，是否开启事务内序号编排。	true
IncrSyncConcurrency	integer	否	反向增量同步线程数，默认值为 64。	64
EnableIncrSyncStatistics	boolean	否	是否开启反向增量记录（DML、DDL）统计。	true
ThrottleRps	integer	否	反向增量传输阶段限制能达到的最大传输速率，单位：记录数/秒，输入 null 时不限制 RPS	null
ThrottleIOPS	integer	否	反向增量传输阶段限制能达到的最大传输流量，单位：字节/秒，输入 null 时不限制 IOPS。	null
SupportDDLTypes	array	否	支持的 DDL 类型。
SupportDDLType	string	否	支持的 DDL 类型。	CREATE_TABLE

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT1111
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	ERROR
Message	string	错误描述（新）。	A system error occurred.
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议（新）。	Contact the administrator.
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）	A system error occurred.
Advice	string	建议（旧）	Contact the administrator.
RequestId	string	请求 ID。	XCVSADG****DSGDS
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	100
Cost	string	请求耗时，单位为秒。	27
Data	string	项目的 ID。	np_****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "Contact the administrator. ",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "XCVSADG****DSGDS",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": "27",
  "Data": "np_****"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-17	API 内部配置变更，不影响调用	查看变更详情
2024-06-26	API 内部配置变更，不影响调用	查看变更详情
2024-04-08	OpenAPI 入参发生变更	查看变更详情
2024-03-20	OpenAPI 入参发生变更	查看变更详情
2024-01-10	API 内部配置变更，不影响调用	查看变更详情
2024-01-09	API 内部配置变更，不影响调用	查看变更详情