调用CreateOmsOpenAPIProject创建数据同步项目_云数据库 OceanBase 版-阿里云帮助中心

创建数据同步项目。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
WorkerGradeId	string	否	传输实例的 ID。通常公有云上创建项目，需要先购买传输实例。	g_abcd
PageNumber	integer	否	页序号，分页查询时生效。	1
PageSize	integer	否	页大小，分页查询时生效。	10
ProjectName	string	否	项目名称。	test-l
LabelIds	array	否	标签 ID 集合。
	string	否	标签 ID。	abcd
SourceConfig	object	否	源端传输配置。
EndpointType	string	否	数据源类型，包括 `MYSQL`、`MARIADB`、`OB_MYSQL`、`OB_MYSQL_CE`、`OB_ORACLE`、`ORACLE、DB2_LUW`、`KAFKA`、`ROCKETMQ`、`DATAHUB`、`SYBASE`、`LOGPROXY`、`ADB`、`DBP_OP_ROUTE`、`DMS`、`IDB` 和 `TIDB`。	OB_MYSQL
EndpointId	string	否	指定数据源 ID。	e_abcdefj
PartitionMode	string	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择分区模式（包括 ONE、HASH 和 TABLE）。	HASH
Partition	integer	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，如果 `partitionMode` 为 ONE 模式，该参数表示分区索引。	0
SerializerType	string	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择文本序列化类型（Default、Canal、DataWorks、SharePlex 和 DefaultExtendColumnType）。	DEFAULT
TopicType	string	否	目标端为 DataHub 时，投递消息所属 Topic 的类型（包括 Tuple 和 Blob）。	TUPLE
SequenceEnable	boolean	否	目标端为 DataHub 时，该参数表示是否开启消息序列。	false
SequenceStartTimestamp	long	否	目标端为 DataHub 时，如果开启消息序列，请设置序列起始时间。单位为秒级时间戳。	1656510473
ProducerGroup	string	否	目标端为 RocketMQ 时，指定投递消息的生产者组。	producer-group-1
MsgTags	string	否	目标端为 RocketMQ 时，设置投递消息的 Tag（标签）。	tag1
EnableMsgTrace	boolean	否	目标端为 RocketMQ 时，该参数表示是否开启消息追踪。	false
SendMsgTimeout	long	否	目标端为 RocketMQ 时，设置单次投递消息的超时时间。	10
DestConfig	object	否	目标端传输配置。
EndpointType	string	否	数据源类型，包括 `MYSQL`、`MARIADB`、`OB_MYSQL`、`OB_MYSQL_CE`、`OB_ORACLE`、`ORACLE`、`DB2_LUW`、`KAFKA`、`ROCKETMQ`、`DATAHUB`、`SYBASE`、`LOGPROXY`、`ADB`、`DBP_OP_ROUTE`、`DMS`、`IDB` 和 `TIDB`。	OB_MYSQL
EndpointId	string	否	指定数据源 ID。	e_abcdefj
PartitionMode	string	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择分区模式（包括 ONE、HASH 和 TABLE）。	HASH
Partition	integer	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，如果 `partitionMode` 为 ONE 模式，该参数表示分区索引。	0
SerializerType	string	否	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择文本序列化类型（包括 Default、Canal、DataWorks、SharePlex 和 DefaultExtendColumnType）。	DEFAULT
TopicType	string	否	目标端为 DataHub 时，投递消息所属 Topic 的类型（包括 Tuple 和 Blob）。	TUPLE
SequenceEnable	boolean	否	目标端为 DataHub 时，该参数表示是否开启消息序列。	false
SequenceStartTimestamp	long	否	目标端为 DataHub 时，如果开启消息序列，请设置序列起始时间。单位为秒级时间戳。	1656510473
ProducerGroup	string	否	目标端为 RocketMQ 时，指定投递消息的生产者组。	producer-group-1
MsgTags	string	否	目标端为 RocketMQ 时，设置投递消息的 Tag（标签）。	tag1
EnableMsgTrace	boolean	否	目标端为 RocketMQ 时，该参数表示是否开启消息追踪。	false
SendMsgTimeout	long	否	目标端为 RocketMQ 时，设置单次投递消息的超时时间。	10
TransferMapping	object	否	传输对象的映射关系。
Mode	string	否	映射类型，包括 `NORMAL` 和 `WHITE_AND_BLACK_LIST`。	NORMAL
Databases	object []	否	传统映射（源端库表映射）列表信息，当且仅当 mode 为 NORMAL 时生效。
TenantName	string	否	映射对象租户，源端为 OceanBase 时生效。	tenant
MappedName	string	否	映射对象 DataBase，目标端为数据库时生效。	mapped_db
DatabaseId	string	否	数据库的 ID。源端为逻辑数据源 IDB 时生效。	db_id1
DatabaseName	string	否	数据库的名称。	db1
Tables	object []	否	数据库中的表信息。
MappedName	string	否	映射对象 Table/Topic。目标端为数据库时，该参数为映射表名。目标端为消息队列时，该参数为映射 Topic。	mapped_table
TableId	string	否	表的 ID，源端为逻辑数据源 IDB 时生效。	table_id
TableName	string	否	表的名称。	table
WhereClause	string	否	行过滤条件。	id > 1
FilterColumns	array	否	过滤列列表，即指定同步哪些列。
	string	否	过滤列。	col
ShardColumns	array	否	分片键列列表，用于目标端为消息队列的场景。
	string	否	分片键列。	col
AdbTableSchema	object	否	ADB 表的 Schema。目标端为 ADB 时，额外配置信息，用于结构同步。
PrimaryKeys	array	否	主键列列表。
	string	否	主键列。	pk
DistributedKeys	array	否	分布键列列表。
	string	否	分布键列。	col
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	integer	否	表的生命周期。	30
Type	string	否	包括 DATABASE 和 TABLE。	DATABASE
Type	string	否	包括 DATABASE 和 TABLE。	DATABASE
TransferStepConfig	object	否	传输步骤配置。
EnableStructSync	boolean	否	是否开启结构同步。	false
EnableFullSync	boolean	否	是否开启全量迁移。	false
EnableIncrSync	boolean	否	是否开启增量同步。	false
IncrSyncStepTransferConfig	object	否	增量同步步骤的配置。
StartTimestamp	long	否	增量同步阶段时，请设置增量起始位点，单位为秒级时间戳。	1637568354
RecordTypeList	array	否	增量同步阶段时，同步的增量数据类型列表。
	string	否	增量同步阶段时，同步的增量数据类型。	BIGINT
StoreLogKeptHour	long	否	有增量同步阶段，且增量日志拉取组件为 Store 时，日志的保存时间。	1
StoreTransactionEnabled	boolean	否	有增量同步阶段，且增量日志拉取组件为 Store 时，是否开启事务内序号编排。	false
TransferStepType	string	否	包括 STRUCT、FULL 和 INCR。	STRUCT
BusinessName	string	否	业务系统标识（可选），投递消息的特定字段。	OMS_TEST

返回参数

名称	类型	描述	示例值
	object	OmsApiReturnResult
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT111111
Level	string	包括 CRITICAL、ERROR 和 WARN。	WARN
Message	string	错误描述（新）。	A system error occurred.
Proposal	string	建议（新）。	Contact the administrator.
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）。	A system error occurred.
Advice	string	建议（旧）。	Contact the administrator.
RequestId	string	请求 ID。	XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	1
TotalCount	long	总数，分页查询时生效。	1
Cost	string	请求耗时，单位为秒。	1
Data	string	是否创建成功。	abcdg

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT111111",
    "Level": "WARN",
    "Message": "A system error occurred.",
    "Proposal": "Contact the administrator."
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "Cost": "1",
  "Data": "abcdg"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-08-19	新增 OpenAPI