调用DescribeProject查询项目的详情_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

本接口用于查询数据迁移或数据同步项目的项目详情。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据迁移或数据同步项目的 ID。	np_fe****

返回参数

名称	类型	描述	示例值
	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	建议（新）。	null
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。	473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	2
Cost	string	请求耗时，单位为秒。	1
Data	object	数据
WorkerGradeId	string	传输实例的 ID。	g_i4wa7***
WorkerGradeInfo	object	传输实例的详情。
Id	string	传输实例的 ID。	g_i4wa7***
Name	string	传输实例的别名。	i5fuij***
Grade	string	传输实例的规格。	OMS_G2_MIGRATION_LARGE
Spec	string	传输实例的规格大小。	LARGE
SpecName	string	传输实例规格大小的名称。	LARGE
SourceType	string	源端数据源的类型。	OB_MYSQL
SourceRegion	string	源端数据源所在的地域。	ap-southeast-1
DestType	string	目标端数据源的类型。	OB_MYSQL
DestRegion	string	目标端数据源所在的地域。	ap-southeast-1
ChargeType	string	数据迁移或数据同步项目的计费类型。	POSTPAY
AutoRenewal	boolean	是否开启自动续费。	false
Expired	boolean	是否已到期。	false
EndTime	string	到期时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。	2024-02-02T16:00:00
GmtCreate	string	创建时间。支持 UTC 时间，格式为 YYYY-MM-DDThh:mm:ss。	2024-01-28T14:07:44
Id	string	项目的 ID。	np_fe****
Type	string	项目的类型，包括 `MIGRATION`（表示数据迁移项目）和 `SYNC`（表示数据同步项目）。	SYNC
Name	string	项目的名称，不能包含空格。	test
Labels	array<object>	标签的集合，最多支持 5 个。
Label	object
Id	string	标签 ID。	l_dr****
Name	string	标签的名称。	test_tag
Owner	string	项目的 Owner。	omsefry***
Importance	string	项目的告警等级，包括 HIGH（高保护状态）、MEDIUM（中保护状态）、LOW（低保护状态）和 IGNORE（无保护状态）。	HIGH
Status	string	数据迁移或数据同步项目的状态，包括 INIT（未启动）、RUNNING（运行中）、SUSPEND（已暂停）、FAILED（失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）和 RUNNING_MERGING（合并中）。	RUNNING
GmtCreate	string	项目的创建时间，以 UTC + 0 时区的时间格式展示。	2023-07-13T06:26:15
GmtModified	string	项目的更新时间，以 UTC + 0 时区的时间格式展示。	2023-07-13T06:26:15
GmtStart	string	项目的开始运行时间。	2023-07-13T07:02:27
GmtFinish	string	项目的结束运行时间。	2023-07-13T07:02:27
DestConnId	string	目标端连接信息的 ID。	c_deg***
IsMerging	boolean	是否处于合并中。	false
IsModifying	boolean	是否处于修改中。	false
IsSubProject	boolean	是否为子项目。	false
SourceEndpointType	string	源端数据源的类型。枚举值： POLARDB_X_1：POLARDB_X_1。 MYSQL：MYSQL。 TIDB：TIDB。 OB_ORACLE：OB_ORACLE。 OB_MYSQL：OB_MYSQL。 ORACLE：ORACLE。 POLARDB_X_2：POLARDB_X_2。	OB_MYSQL
SinkEndpointType	string	目标端数据源的类型。枚举值： MYSQL：MYSQL。 OB_ORACLE：OB_ORACLE。 KAFKA：KAFKA。 ROCKETMQ：ROCKETMQ。 DATAHUB：DATAHUB。 OB_MYSQL：OB_MYSQL。 ORACLE：ORACLE。 ADB：ADB。	MYSQL
TransferMapping	object	传输对象及其映射关系。
Mode	string	传输对象映射模式，包括 `SPECIFIC`（表示指定对象）和 `WILDCARD`（表示匹配规则）。	SPECIFIC
Databases	array<object>	数据库对象列表。
Databases	object
Type	string	数据库的类型。	MYSQL
Id	string	数据库的 ID。	db_id
Name	string	数据库的名称。	db_name
MappedName	string	数据库的映射名称。	mapped_db
TenantName	string	映射对象租户，源端为 OceanBase 数据源时生效。	tenant_name
Tables	array<object>	当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。
Tables	object
Name	string	表的名称。	table_name
MappedName	string	表的映射名称。	mapped_table
Id	string	表的 ID。	table_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id > 1
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col1
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
AdbTableSchema	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col2
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
Views	array<object>	当前数据库中传输视图对象的配置列表。
Views	object
Name	string	视图的名称。	view_name
MappedName	string	视图的映射名称。	mapped_view
Id	string	视图的 ID。	fexdg***
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id < 1
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col1
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col2
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
SpecificTables	array<object>	具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。
SpecificTables	object
Name	string	表的名称。	table_name
MappedName	string	表的映射名称。	mapped_table
Id	string	表的 ID。	table_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>1
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	col
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
SpecificViews	array<object>	具体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。
SpecificViews	object
Name	string	视图的名称。	view_name
MappedName	string	视图的映射名称。	mapped_name
Id	string	视图的 ID。	view_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<3
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
DatabasesBlack	array<object>	匹配规则模式：数据库对象黑名单列表。
DatabasesBlack	object
Type	string	包括 DATABASE 和 TABLE。	DATABASE
Id	string	数据库对象的 ID。	db_id
Name	string	数据库对象的名称。	db_name
MappedName	string	数据库的映射名称。	mapped_db
TenantName	string	映射对象租户，源端为 OceanBase 时生效。	mapped_tenant
Tables	array<object>	当前数据库中传输表对象的配置。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。
Tables	object
Name	string	表的名称。	table_name
MappedName	string	表的映射名称。	mapped_table
Id	string	表的 ID。	table_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>1
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
Views	array<object>	当前数据库中传输视图对象的配置列表。
Views	object
Name	string	视图的名称。	view_name
MappedName	string	视图的映射名称。	mapped_name
Id	string	视图的 ID。	view_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>2
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
SpecificTables	array<object>	具体表对象的配置集合。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。
SpecificTables	object
Name	string	表的名称。	table_name
MappedName	string	表的映射名称。	mapped_table
Id	string	表的 ID。	table_id
WhereClause	string	标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<3
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
SpecificViews	array<object>	体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。
SpecificViews	object
Name	string	视图的名称。	view_name
MappedName	string	视图的映射名称。	mapped_view
Id	string	视图的 ID。	view_id
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>2
FilterColumns	array	过滤列集合。
FilterColumns	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumns	string	分片键列。	col
AdbTableSchema	object	ADB 数据源的映射信息。
PrimaryKeys	array	主键列集合。
PrimaryKeys	string	主键列。	pk
DistributedKeys	array	分布键列集合。
DistributedKeys	string	分布键列。	col
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	表的生命周期。	30
TableAndViewWhiteList	array	匹配规则模式：表和视图的通配白名单列表。
TableAndViewWhiteList	string	匹配规则模式：表和视图的通配白名单。	null
TableAndViewBlackList	array	匹配规则模式：表和视图的通配黑名单列表。
TableAndViewBlackList	string	匹配规则模式：表和视图的通配黑名单。	null
CommonTransferConfig	object	通用的传输配置。
TableCategory	string	支持的表类型。包括 ALL（所有表）、WITH_UNIQUE_ROW_ID（有唯一行标识的表）和 WITHOUT_UNIQUE_ROW_ID（无唯一行标识的表），默认值为 ALL。	ALL
ActiveActive	boolean	是否为容灾双活场景。	true
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 时生效）。	true
RocketMqSendMsgTimeout	long	设置消息投递超时时间（目标端为 ROCKETMQ 时生效）。	null
DataWorksBusinessName	string	业务系统标识（可选）。	null
SinkStoreFormat	string	业务系统标识(可选)
SourceStoreFormat	string	业务系统标识(可选)
EnableStructTransfer	boolean	是否启用结构传输。	true
StructTransferConfig	object	结构传输配置。
ByteCharConvertStrategy	string	byte/char 转换方案，包括 `IGNORE_BYTE_IF_BYTE_USED`、`FORCE_CHAR_IF_BYTE_USED`、`EXPAND_LEN_IF_BYTE_USED` 和 `DO_NOTHING_IF_BYTE_USED`（默认值）。	DO_NOTHING_IF_BYTE_USED
DeferIndexCreation	boolean	是否允许索引后置。	true
EnableFullTransfer	boolean	是否启用全量传输。	true
EnableFullVerify	boolean	是否启用全量校验。	true
FullTransferConfig	object	全量传输的配置。
NonePkUkTruncateDstTable	boolean	处理源端无唯一索引表的全量迁移时，是否清空目标表。	false
AllowDestTableNotEmpty	boolean	目标端表对象存在记录时处理策略，包括忽略和停止迁移。设置为 true，表示选择忽略：当目标端表对象存在数据时，如果原数据与写入数据冲突，数据传输采用将冲突数据记录日志，保留原数据不变的策略进行数据写入。注意选择忽略，全量校验将使用 IN 模式拉取数据，无法校验目标端多数据的场景，并且校验性能存在一定程度降级。设置为 false，表示选择停止迁移：当目标端表对象存在数据时，全量迁移会报错不允许迁移，请处理好目标端数据后再继续迁移。注意如果出错后单击恢复，数据传输将忽略该配置选项，继续迁移表数据，请谨慎操作。	true
FullTransferSpeedMode	string	全量迁移并发速度，包括 STEADY、NORMAL 和 FAST。	FAST
FullVerifySpeedMode	string	全量校验并发速度，包括 STEADY、NORMAL 和 FAST。	FAST
WriteWorkerNum	integer	写入并发数。	64
ReadWorkerNum	integer	读取并发数。	64
ThrottleRps	integer	全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。返回 null 时，表示没有限制 RPS。	null
ThrottleIOPS	integer	全量传输阶段限制能达到的最大传输流量，单位为字节/秒。返回 null 时，表示没有限制 IOPS。	null
EnableIncrTransfer	boolean	是否启用增量传输。	true
EnableIncrVerify	boolean	是否启用增量校验。	true
EnableReverseIncrTransfer	boolean	是否启用反向增量同步。	true
IncrTransferConfig	object	增量同步的配置。
StartTimestamp	long	增量同步起始位点。仅启用增量同步但未启用全量传输时，支持设置该参数。	1667286900
RecordTypeWhiteList	array	有增量同步阶段时，同步的增量数据类型。
RecordTypeWhiteList	string	有增量同步阶段时，同步的增量数据类型。枚举值： DELETE：DELETE。 COMMIT：COMMIT。 INSERT：INSERT。 UPDATE：UPDATE。 BEGIN：BEGIN。 ROW：ROW。 HEARTBEAT：HEARTBEAT。 DDL：DDL。 ROLLBACK：ROLLBACK。	INSERT
StoreLogKeptHour	integer	有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。	24
EnableSequencingWithinTxn	boolean	有增量同步阶段且增量日志拉取组件为 Store 时，是否开启事务内序号编排。	false
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 类型。枚举值： DROP_INDEX：DROP_INDEX。 RENAME_TABLE：RENAME_TABLE。 DROP_TABLE：DROP_TABLE。 TRUNCATE_TABLE：TRUNCATE_TABLE。 ALTER_TABLE：ALTER_TABLE。 CREATE_TABLE：CREATE_TABLE。 CREATE_INDEX：CREATE_INDEX。	CREATE_TABLE
ReverseIncrTransferConfig	object	反向增量配置。
StartTimestamp	long	勾选了增量且没勾选全量时，允许设置增量起始位点，秒级时间戳。	1687363200
RecordTypeWhiteList	array	有反向增量传输阶段时，同步的数据类型。
RecordTypeWhiteList	string	有反向增量传输阶段时，同步的数据类型。枚举值： DELETE：DELETE。 COMMIT：COMMIT。 INSERT：INSERT。 UPDATE：UPDATE。 BEGIN：BEGIN。 ROW：ROW。 HEARTBEAT：HEARTBEAT。 DDL：DDL。 ROLLBACK：ROLLBACK。	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 类型。枚举值： DROP_INDEX：DROP_INDEX。 RENAME_TABLE：RENAME_TABLE。 DROP_TABLE：DROP_TABLE。 TRUNCATE_TABLE：TRUNCATE_TABLE。 ALTER_TABLE：ALTER_TABLE。 CREATE_TABLE：CREATE_TABLE。 CREATE_INDEX：CREATE_INDEX。	CREATE_TABLE
SourceConnectInfo	object	源端节点的连接信息。
Id	string	连接信息的 ID。	c_feg****
EndpointName	string	终端节点的名称。	migon****
EndpointId	string	终端节点的 ID。	e_3kx5i***1s
EndpointSide	string	终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。	source
DbEngine	string	终端节点的数据库引擎。	OB_MYSQL_PUBLIC
ConnectionInfo	string	终端节点的连接信息。	null
Username	string	连接用户名。	oms2027obmysql@oms_***
Version	string	数据库的版本。	2.2.77
Timezone	string	数据库的时区。	+08:00
Charset	string	字符编码。	utf8mb4
NlsLengthSemantics	string	nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。	null
OperatingSystem	string	操作系统（OceanBase 数据库无该参数）。	Linux
Region	string	地域。	cn-shanghai
OcpName	string	OCP 的名称。	null
ConnExtraAttributes	any	连接额外属性。具体返回字段请参见《附录》模块的内容。	null
Owner	string	Owner。	oms_test
ResourceOwner	string	资源所有者的 UID。	1325847***
Host	string	IP 地址。	xxx.xxx.xxx.1
Port	integer	端口。	2883
SinkConnectInfo	object	目标端节点的连接信息。
Id	string	连接信息的 ID。	e_4lgzuzi9znr4
EndpointName	string	终端节点的名称。	RATION12948*****
EndpointId	string	终端节点的 ID。	e_4w1q****
EndpointSide	string	终端节点的类型，包括 `source`（源端）和 `dest`（目标端）。	sink
DbEngine	string	终端节点的数据库引擎。	MYSQL_PUBLIC
ConnectionInfo	string	终端节点的连接信息。	null
Username	string	连接用户名。	oms2027obmysql@oms_***
Version	string	数据库的版本。	2.2.77
Timezone	string	数据库的时区。	+08:00
Charset	string	字符编码。	utf8mb4
NlsLengthSemantics	string	nlsLengthSemantics 属性，仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。	null
OperatingSystem	string	操作系统（OceanBase 数据库无该参数）。	Linux
Region	string	地域。	cn-hangzhou
OcpName	string	OCP 的名称。	null
ConnExtraAttributes	any	连接额外属性。具体返回字段请参见《附录》模块的内容。	null
Owner	string	Owner。	oms_test
ResourceOwner	string	资源所有者的 UID。	1325847***
Host	string	IP 地址。	xxx.xxx.xxx.1
Port	integer	端口。	2883
Steps	array<object>	步骤列表。
Step	object
Order	integer	步骤的运行顺序。	1
Name	string	步骤的名称。	PRE_CHECK
Description	string	步骤的描述（预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换）。	预检查
Status	string	步骤的运行状态，包括 INIT（初始化）、RUNNING（运行中）、FAILED（失败）、 FINISHED（已完成）、 SUSPEND（已暂停）、MONITORING（持续监控状态，用于增量同步和增量校验的持续监控态）。	RUNNING
ExtraInfo	object	补充信息（json）
ErrorDetails	array<object>	错误详情
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
ErrorCode	string	错误码。	INNER_ERROR
ErrorMsg	string	错误描述。	A system error occurred.
ErrorParam	object	错误的相关参数。
	string	错误相关参数。	null
FailedTime	string	错误时间。	null
StartTime	string	开始时间，以 UTC + 0 时区的时间格式展示。	2020-05-22T17:04:18
FinishTime	string	结束时间，以 UTC + 0 时区的时间格式展示。	2020-05-22T17:04:18
Progress	integer	步骤的运行进度。	90
StepInfo	object	各步骤的运行详情。具体包含的信息请参见《StepInfo 数据结构》。	全量传输
ExtraInfo	object	错误信息等补充信息。
RunningStep	string	处于 RUNNING 状态的步骤。	PRE-CHECK
RunningProgress	integer	处于 RUNNING 状态的步骤的运行进度。	90
MonitoringIncr	boolean	是否开始监控增量。	true
Subtopics	array	项目关联 Store 的 Subtopics 列表。
Subtopic	string	项目关联 Store 的 Subtopic。	null
ReverseSubtopics	array	项目关联反向 Store 的 Subtopics 列表。
ReverseSubtopic	string	项目关联反向 Store 的 Subtopic。	null
LogServiceStartCheckpoint	long	起始位点。	1689214358
SourceStoreKeptHour	integer	日志保存时间。	24
SyncDelay	long	增量同步的延时时间。	null
SyncDelaySampleTimestamp	long	同步延迟的采集时间戳，秒级别。	1689214358
AccessObSource	boolean	是否能够直连源端 OceanBase 数据库。	true
OverwriteConfig	boolean	是否允许完全覆盖更新配置。	true
IgnoreUnsupportDdl	boolean	是否忽略不支持的 DDL。	false
SubDbs	object	记录不同下游消费方的表配置，用于数据同步项目复用时的配置合并。
	array<object>	记录不同下游消费方的表配置，用于数据同步项目复用时的配置合并。
Item	object
ClusterName	string	集群名称。	cluster_name
TenantName	string	租户的名称。	tenant_name
DatabaseId	string	数据库的 ID。目前仅逻辑库才会具有 ID，可能存在在一个 Endpoint 中库名相同，但是 ID 不同。表示的是不同的 ID 情况。	null
DatabaseName	string	数据库的名称。	db_name
MappingDatabaseName	string	数据库的映射名称。	mapped_db
SourceClientId	string	Connector Client 的 ID。	null
Tables	array<object>	待传输表的列表。
Table	object
TableId	string	表的 ID。	fexg***
Database	string	数据库的名称。	db_name
TableName	string	表的名称。	table_name
MappingTableName	string	表的映射名称。	mapped_table
Instance	string	传输实例的 ID。	g_i4kat***
Columns	array<object>	待传输列的列表。
Column	object
ColumnName	string	列的名称。	null
Position	integer	字段的位置。	null
ColumnType	string	列的类型。	null
RecordFieldType	string	列类型的引申。	null
RawColumnType	string	数据库记录的列类型的原始字符串。	null
ColumnKey	string	索引的类型。	null
Nullable	boolean	是否可以为空。	true
DefaultValue	string	默认值。	null
DataLength	long	列的长度。	null
DataPrecision	integer	列的精度。	64
DataScale	integer	小数点。	null
Encoding	string	列的字符编码。	utf8
ColumnComment	string	列的注释。	comments
IsGenerateField	boolean	是否为隐藏列。	false
SubConds	object	同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。
	array<object>	同步 DataWorks 场景，记录不同下游消费方的表配置，用于同步任务复用时的配置合并。
Item	object
TenantName	string	租户的名称。	tenant_name
Database	string	源端数据库的名称。	db_name
DestDatabase	string	目标端数据库的名称。	dest_db
TableName	string	源端表的名称。	table_name
DestName	string	目标端表的名称。	dest_name
WhereClause	string	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id>1
FilterColumns	array	过滤列集合。
FilterColumn	string	过滤列。	col
ShardColumns	array	分片键列集合。
ShardColumn	string	分片键列。	col
LogicTableId	string	针对逻辑表下，逻辑表的 ID。	null
SourceEndpointId	string	针对物理表下传递 endpointId。	null
SourceClientId	string	用于标识处理该 DatabaseName 的 Source Client。	null
SubIds	object	配置对象的 ID 列表。
	string	配置对象的 ID。	null
MaxConnectorCount	integer	Connector 的最大数量，-1 表示不限制。	-1
StoreIncr	boolean	是否保存增量。	true
IncrSyncTimestamp	long	增量同步的当前位点，单位为秒级时间戳。	1689244596
AlarmStats	object	告警统计信息。
Target	string	被告警的目标。	null
Alarming	boolean	是否正在告警。	false
RecentlyTriggerCount	integer	最近告警消息的总数量。	0
RuleToRecentlyTriggerCount	object	分规则最近告警消息的数量。
	integer	分规则最近告警消息的数量。	0
AlarmContent	string	最近告警消息的内容。	null
OpenMonitor	boolean	公有云下，是否开启监控告警开关。	true

StepInfo 数据结构

不同步骤的 StepInfo 参数返回不同的字段。

TRANSFER_APP_SWITCH（正向切换）

参数类型描述
checkpointSampleTimestamp long 位点采集时间。格式为 Unix timestamp，单位为秒。

参数	类型	描述
checkpointSampleTimestamp	long	位点采集时间。格式为 Unix timestamp，单位为秒。

INCR_TRANSFER（增量同步）

参数	类型	描述
incrTimestampCheckpoint	long	位点时间。格式为 Unix timestamp，单位为秒。
checkpointSampleTimestamp	long	位点采集时间。格式为 Unix timestamp，单位为秒。
enableIncrStatistics	boolean	是否开启 DML/DDL 统计。

FULL_VERIFIER（全量校验）和 FULL_TRANSFER（全量迁移）

参数	类型	描述
processedRecords	long	已完成迁移行数/实际行数。
capacity	long	预估总行数。
srcRps	long	源端读取 RPS，单位为记录数/秒。
srcRt	string	源端读取 RT，单位为毫秒/条。
srcIops	long	源端读取流量，单位为字节数/秒。
dstRps	long	目标端读取/写入 RPS，单位为记录数/秒。
dstRt	long	目标端读取/写入 RT，单位为毫秒/条。
dstIops	long	目标端读取/写入流量，单位为字节数/秒。
srcRpsRef	long	源端读取 RPS 的基准值。
dstRpsRef	long	目标端读取/写入 RPS 的基准值。
dstRtRef	long	目标端读取/写入 RT 基准值。

附录

Kafka

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "username":null,
        "enableSSL":null,
        "enableSASL":null,
        "saslMechanism":null,
        "disableIdentificationAlgorithm":false
    }
}

参数	类型	描述
endpoint	string	服务地址。
username	string	用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时，该参数必填。
enableSSL	boolean	是否开启 SSL 认证。如果开启，则需要上传授信证书。
enableSASL	boolean	是否开启 SASL 认证。
saslMechanism	KafkaSaslMechanisnEnum	加密方式，包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。
disableIdentificationAlgorithm	boolean	SSL 加密时，是否开启主机名验证。

DataHub

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "project":"detx***"
    }
}

参数	类型	描述
endpoint	string	服务地址。
project	string	项目的名称。

RocketMQ

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "endpointType":null,
        "version":null
    }
}

参数	类型	描述
endpoint	string	服务地址。
endpointType	CloudRocketMQEndpoint.Type	服务地址的类型。
version	CloudRocketMQInst.Version	RocketMQ 的版本。

OceanBase

{
    "connExtraAttributes":{
        "cluster":"xgez***",
        "tenant":"gexr**",
        "isLogicSource":false,
        "useLogProxy":true,
        "drcUser":"tes***",
        "configUrl":"http://xxx.xxx.xxx.1:2883/service****",
        "logProxyIp":"xxx.xxx.xxx.2",
        "logProxyPort":2883,
        "noUserAuth":false
    }
}

参数	类型	描述
cluster	string	集群的名称。
tenant	string	租户的名称。
isLogicSource	boolean	是否为逻辑数据源。
useLogProxy	boolean	是否使用 LogProxy。
drcUser	string	drc_user 的配置。
configUrl	string	用于获取 OceanBase 数据库底层服务器的真实地址。
logProxyIp	string	LogProxy 服务的 IP 地址。
logProxyPort	integer	LogProxy 服务的端口。
noUserAuth	boolean	对于同步 DataWorks 的接口，数据源是 OMS 自动生成的。如果没有用户账号和密码，则不能连接用户的 OceanBase 数据库。

TiDB

{
    "connExtraAttributes":{
        "kafkaId":"e_edz****",
        "kafkaTopic":"test**",
        "kafkaName":"denz***"
    }
}

参数	类型	描述
kafkaId	string	绑定的 Kafka 数据源的 ID。
kafkaTopic	string	绑定的 Kafka Topic 的名称。
kafkaName	string	绑定的 Kafka 数据源的名称。

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator. ",
  "RequestId": "473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Cost": "1",
  "Data": {
    "WorkerGradeId": "g_i4wa7***\n",
    "WorkerGradeInfo": {
      "Id": "g_i4wa7***\n",
      "Name": "i5fuij***",
      "Grade": "OMS_G2_MIGRATION_LARGE",
      "Spec": "LARGE",
      "SpecName": "LARGE",
      "SourceType": "OB_MYSQL",
      "SourceRegion": "ap-southeast-1",
      "DestType": "OB_MYSQL",
      "DestRegion": "ap-southeast-1",
      "ChargeType": "POSTPAY",
      "AutoRenewal": false,
      "Expired": false,
      "EndTime": "2024-02-02T16:00:00",
      "GmtCreate": "2024-01-28T14:07:44"
    },
    "Id": "np_fe****",
    "Type": "SYNC",
    "Name": "test",
    "Labels": [
      {
        "Id": "l_dr****",
        "Name": "test_tag"
      }
    ],
    "Owner": "omsefry***",
    "Importance": "HIGH",
    "Status": "RUNNING",
    "GmtCreate": "2023-07-13T06:26:15",
    "GmtModified": "2023-07-13T06:26:15\n",
    "GmtStart": "2023-07-13T07:02:27",
    "GmtFinish": "2023-07-13T07:02:27",
    "DestConnId": "c_deg***",
    "IsMerging": true,
    "IsModifying": true,
    "IsSubProject": false,
    "SourceEndpointType": "OB_MYSQL",
    "SinkEndpointType": "MYSQL",
    "TransferMapping": {
      "Mode": "SPECIFIC",
      "Databases": [
        {
          "Type": "MYSQL",
          "Id": "db_id",
          "Name": "db_name",
          "MappedName": "mapped_db",
          "TenantName": "tenant_name",
          "Tables": [
            {
              "Name": "table_name",
              "MappedName": "mapped_table",
              "Id": "table_id",
              "WhereClause": "id > 1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col1"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "Views": [
            {
              "Name": "view_name",
              "MappedName": "mapped_view",
              "Id": "fexdg***",
              "WhereClause": "id < 1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col1"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "SpecificTables": [
            {
              "Name": "table_name",
              "MappedName": "mapped_table",
              "Id": "table_id",
              "WhereClause": "id>1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "col"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "SpecificViews": [
            {
              "Name": "view_name",
              "MappedName": "mapped_name",
              "Id": "view_id",
              "WhereClause": "id<3",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ]
        }
      ],
      "DatabasesBlack": [
        {
          "Type": "DATABASE",
          "Id": "db_id",
          "Name": "db_name",
          "MappedName": "mapped_db",
          "TenantName": "mapped_tenant",
          "Tables": [
            {
              "Name": "table_name",
              "MappedName": "mapped_table",
              "Id": "table_id",
              "WhereClause": "id>1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "Views": [
            {
              "Name": "view_name",
              "MappedName": "mapped_name",
              "Id": "view_id",
              "WhereClause": "id>2",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "SpecificTables": [
            {
              "Name": "table_name",
              "MappedName": "mapped_table",
              "Id": "table_id",
              "WhereClause": "id<3",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ],
          "SpecificViews": [
            {
              "Name": "view_name",
              "MappedName": "mapped_view",
              "Id": "view_id",
              "WhereClause": "id>2",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col"
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')\n",
                "PartitionLifeCycle": "30"
              }
            }
          ]
        }
      ],
      "TableAndViewWhiteList": [
        "null"
      ],
      "TableAndViewBlackList": [
        "null"
      ]
    },
    "CommonTransferConfig": {
      "TableCategory": "ALL",
      "ActiveActive": true,
      "MqSerializerType": "DEFAULT",
      "MqPartitionMode": "ONE",
      "MqPartition": 0,
      "DatahubTopicType": "TUPLE",
      "RocketMqProducerGroup": "OMS",
      "RocketMqMsgTags": "default_tag",
      "RocketMqEnableMsgTrace": true,
      "RocketMqSendMsgTimeout": 0,
      "DataWorksBusinessName": "null",
      "SinkStoreFormat": "",
      "SourceStoreFormat": ""
    },
    "EnableStructTransfer": true,
    "StructTransferConfig": {
      "ByteCharConvertStrategy": "DO_NOTHING_IF_BYTE_USED",
      "DeferIndexCreation": true
    },
    "EnableFullTransfer": true,
    "EnableFullVerify": true,
    "FullTransferConfig": {
      "NonePkUkTruncateDstTable": false,
      "AllowDestTableNotEmpty": true,
      "FullTransferSpeedMode": "FAST",
      "FullVerifySpeedMode": "FAST",
      "WriteWorkerNum": 64,
      "ReadWorkerNum": 64,
      "ThrottleRps": 0,
      "ThrottleIOPS": 0
    },
    "EnableIncrTransfer": true,
    "EnableIncrVerify": true,
    "EnableReverseIncrTransfer": true,
    "IncrTransferConfig": {
      "StartTimestamp": 1667286900,
      "RecordTypeWhiteList": [
        "INSERT"
      ],
      "StoreLogKeptHour": 24,
      "EnableSequencingWithinTxn": false,
      "IncrSyncConcurrency": 64,
      "EnableIncrSyncStatistics": true,
      "ThrottleRps": 0,
      "ThrottleIOPS": 0,
      "SupportDDLTypes": [
        "CREATE_TABLE"
      ]
    },
    "ReverseIncrTransferConfig": {
      "StartTimestamp": 1687363200,
      "RecordTypeWhiteList": [
        "INSERT"
      ],
      "StoreLogKeptHour": 24,
      "EnableSequencingWithinTxn": true,
      "IncrSyncConcurrency": 64,
      "EnableIncrSyncStatistics": true,
      "ThrottleRps": 0,
      "ThrottleIOPS": 0,
      "SupportDDLTypes": [
        "CREATE_TABLE"
      ]
    },
    "SourceConnectInfo": {
      "Id": "c_feg****",
      "EndpointName": "migon****",
      "EndpointId": "e_3kx5i***1s",
      "EndpointSide": "source",
      "DbEngine": "OB_MYSQL_PUBLIC",
      "ConnectionInfo": "null",
      "Username": "oms2027obmysql@oms_***",
      "Version": "2.2.77",
      "Timezone": "+08:00",
      "Charset": "utf8mb4",
      "NlsLengthSemantics": "null\n",
      "OperatingSystem": "Linux",
      "Region": "cn-shanghai",
      "OcpName": "null",
      "ConnExtraAttributes": "null",
      "Owner": "oms_test",
      "ResourceOwner": "1325847***\n",
      "Host": "xxx.xxx.xxx.1",
      "Port": 2883
    },
    "SinkConnectInfo": {
      "Id": "e_4lgzuzi9znr4",
      "EndpointName": "RATION12948*****",
      "EndpointId": "e_4w1q****",
      "EndpointSide": "sink",
      "DbEngine": "MYSQL_PUBLIC",
      "ConnectionInfo": "null",
      "Username": "oms2027obmysql@oms_***\n",
      "Version": "2.2.77",
      "Timezone": "+08:00",
      "Charset": "utf8mb4",
      "NlsLengthSemantics": "null",
      "OperatingSystem": "Linux",
      "Region": "cn-hangzhou",
      "OcpName": "null",
      "ConnExtraAttributes": "null",
      "Owner": "oms_test",
      "ResourceOwner": "1325847***\n",
      "Host": "xxx.xxx.xxx.1\n",
      "Port": 2883
    },
    "Steps": [
      {
        "Order": 1,
        "Name": "PRE_CHECK",
        "Description": "预检查",
        "Status": "RUNNING",
        "ExtraInfo": {
          "ErrorDetails": [
            {
              "Code": "\t\nCM-RESOAT1111\n",
              "Level": "ERROR",
              "Message": "A system error occurred.\n",
              "ExtraContext": {
                "key": "null"
              },
              "MessageMcmsKey": "null",
              "MessageMcmsContext": {
                "key": "null"
              },
              "Reason": "null",
              "ReasonMcmsKey": "null",
              "ReasonMcmsContext": {
                "key": "null"
              },
              "Proposal": "Contact the administrator. \n\n",
              "ProposalMcmsKey": "null",
              "ProposalMcmsContext": {
                "key": "null"
              },
              "UpstreamErrorDetail": "null"
            }
          ],
          "ErrorCode": "INNER_ERROR",
          "ErrorMsg": "A system error occurred.\n",
          "ErrorParam": {
            "key": "null"
          },
          "FailedTime": "null"
        },
        "StartTime": "2020-05-22T17:04:18",
        "FinishTime": "2020-05-22T17:04:18",
        "Progress": 90,
        "StepInfo": {
          "test": "test",
          "test2": 1
        }
      }
    ],
    "ExtraInfo": {
      "RunningStep": "PRE-CHECK",
      "RunningProgress": 90,
      "MonitoringIncr": true,
      "Subtopics": [
        "null"
      ],
      "ReverseSubtopics": [
        "null"
      ],
      "LogServiceStartCheckpoint": 1689214358,
      "SourceStoreKeptHour": 24,
      "SyncDelay": 0,
      "SyncDelaySampleTimestamp": 1689214358,
      "AccessObSource": true,
      "OverwriteConfig": true,
      "IgnoreUnsupportDdl": false,
      "SubDbs": {
        "key": [
          {
            "ClusterName": "cluster_name",
            "TenantName": "tenant_name",
            "DatabaseId": "null",
            "DatabaseName": "db_name",
            "MappingDatabaseName": "mapped_db",
            "SourceClientId": "null",
            "Tables": [
              {
                "TableId": "fexg***",
                "Database": "db_name",
                "TableName": "table_name",
                "MappingTableName": "mapped_table",
                "Instance": "g_i4kat***",
                "Columns": [
                  {
                    "ColumnName": "null",
                    "Position": 0,
                    "ColumnType": "null",
                    "RecordFieldType": "null",
                    "RawColumnType": "null",
                    "ColumnKey": "null",
                    "Nullable": true,
                    "DefaultValue": "null",
                    "DataLength": 0,
                    "DataPrecision": 64,
                    "DataScale": 0,
                    "Encoding": "utf8",
                    "ColumnComment": "comments",
                    "IsGenerateField": false
                  }
                ]
              }
            ]
          }
        ]
      },
      "SubConds": {
        "key": [
          {
            "TenantName": "tenant_name",
            "Database": "db_name",
            "DestDatabase": "dest_db",
            "TableName": "table_name",
            "DestName": "dest_name",
            "WhereClause": "id>1",
            "FilterColumns": [
              "col"
            ],
            "ShardColumns": [
              "col"
            ],
            "LogicTableId": "null",
            "SourceEndpointId": "null",
            "SourceClientId": "null"
          }
        ]
      },
      "SubIds": {
        "key": "null"
      },
      "MaxConnectorCount": -1,
      "StoreIncr": true,
      "IncrSyncTimestamp": 1689244596
    },
    "AlarmStats": {
      "Target": "null",
      "Alarming": false,
      "RecentlyTriggerCount": 0,
      "RuleToRecentlyTriggerCount": {
        "key": 0
      },
      "AlarmContent": "null",
      "OpenMonitor": true
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-06-26	OpenAPI 返回结构发生变更	查看变更详情
2024-04-08	OpenAPI 返回结构发生变更	查看变更详情
2024-03-20	OpenAPI 返回结构发生变更	查看变更详情