CreateProjectModifyRecords - 修改传输对象_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

本接口用于修改处于运行中、失败或已暂停状态的数据迁移或数据同步任务的迁移/同步对象。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据迁移或数据同步任务的 ID。	np_fe****
Databases	array<object>	否	数据库对象列表。
	object	否
Id	string	否	数据库的 ID。	db_id
Name	string	否	数据库的名称。	db_name
MappedName	string	否	数据库的映射名称。	mapped_db
Tables	array<object>	否	当前数据库中传输表对象的配置。Mode 为 WILDCARD 时，该参数表示具体黑名单或白名单的配置，表和视图共用。
	object	否
Name	string	否	表的名称。	table_name
MappedName	string	否	表的映射名称。	mapped_table
Id	string	否	表的 ID。	table_id
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片键列集合。
	string	否	分片键列。	col1
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col2
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
ObkvPartitionConfig	object	否	Hbase 模式分区配置，仅迁移到 OBKV 场景下使用
Views	array<object>	否	当前数据库中传输视图对象的配置列表。
	object	否
Name	string	否	视图的名称。	view_name
MappedName	string	否	视图的映射名称。	mapped_view
Id	string	否	视图的 ID。	view_id
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片键列集合。
	string	否	分片键列。	col1
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col2
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。	table_id
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id<1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片键列集合。
	string	否	分片键列。	col1
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col2
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
SpecificViews	array<object>	否	具体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。
	object	否
Name	string	否	视图的名称。	view_name
MappedName	string	否	视图的映射名称。	mapped_view
Id	string	否	视图的 ID。	view_id
WhereClause	string	否	通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。	id <1
FilterColumns	array	否	过滤列集合。
	string	否	过滤列。	col
ShardColumns	array	否	分片键列集合。
	string	否	分片键列。	col1
AdbTableSchema	object	否	ADB 数据源的映射信息。
PrimaryKeys	array	否	主键列集合。
	string	否	主键列。	pk
DistributedKeys	array	否	分布键列集合。
	string	否	分布键列。	col2
PartitionStatement	string	否	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	string	否	表的生命周期。	30
TransferMapping	object	否	传输对象列表（修改匹配规则时必填）
Mode	string	否	传输对象映射模式（SPECIFIC 指定对象、WILDCARD 匹配规则、COMPLEX 混合规则）	SPCEIFIC
Databases	array<object>	否	数据库信息
	object	否
Id	string	否	库 ID
Name	string	否	数据库名
MappedName	string	否	数据库映射名
ClusterName	string	否	映射对象集群（已废弃）
TenantName	string	否	映射对象租户（已废弃）
Tables	array<object>	否	当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
Id	string	否	表 ID
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
ObkvPartitionConfig	object	否	Hbase 模式分区配置，仅迁移到 OBKV 场景下使用
Views	array<object>	否	当前库下的传输视图对象配置
	object	否
Name	string	否	视图名
MappedName	string	否	视图映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificTables	array<object>	否	具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificViews	array<object>	否	具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）
	object	否
Name	string	否	视图名
MappedName	string	否	视图映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
DatabasesBlack	array<object>	否	匹配规则模式：数据库对象黑名单
	object	否
Name	string	否	库名
MappedName	string	否	映射库名
ClusterName	string	否	映射对象集群（已废弃）
TenantName	string	否	映射对象租户（已废弃）
Tables	array<object>	否	当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
Id	string	否	表 ID
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
Views	array<object>	否	当前库下的传输视图对象配置
	object	否
Name	string	否	视图名
MappedName	string	否	视图映射名
Id	string	否	视图 ID
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificTables	array<object>	否	具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）
	object	否
Name	string	否	表名
Id	string	否	表 ID
MappedName	string	否	表映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificViews	array<object>	否	具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
Id	string	否	视图 ID
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
TableAndViewWhiteList	array	否	匹配规则模式：表、视图的通配白名单
	string	否
TableAndViewBlackList	array	否	匹配规则模式：表、视图的通配黑名单
	string	否
WhiteTableRules	array<object>	否	表白名单规则
	object	否
SchemaMapping	object	否	schema 映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
ObjectMapping	object	否	schema 下的对象映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
WhiteViewRules	array<object>	否	视图白名单规则
	object	否
SchemaMapping	object	否	schema 映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
ObjectMapping	object	否	schema 下的对象映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
BlackTableRules	array<object>	否	表黑名单规则
	object	否
SchemaMapping	object	否	schema 映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
ObjectMapping	object	否	schema 下的对象映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
BlackViewRules	array<object>	否	视图黑名单规则
	object	否
SchemaMapping	object	否	schema 映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
ObjectMapping	object	否	schema 下的对象映射
Name	string	否	对象名称
MappedName	string	否	映射对象名称
Schemas	array<object>	否	精确库表对象设置
	object	否
Id	string	否	库 ID
Name	string	否	数据库名
MappedName	string	否	数据库映射名
ClusterName	string	否	映射对象集群（已废弃）
TenantName	string	否	映射对象租户（已废弃）
Tables	array<object>	否	当前库下的传输表对象配置（mode 为 WILDCARD 时，该字段表示具体黑名单或者白名单的配置，表和视图共用）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
Id	string	否	表 ID
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
ObkvPartitionConfig	object	否	Hbase 模式分区配置，仅迁移到 OBKV 场景下使用
Views	array<object>	否	当前库下的传输视图对象配置
	object	否
Name	string	否	视图名
MappedName	string	否	视图映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificTables	array<object>	否	具体表对象配置（mode 为 WILDCARD 时，该字段表示具体表对象的重命名、行过滤配置）
	object	否
Name	string	否	表名
MappedName	string	否	表映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息
SpecificViews	array<object>	否	具体视图对象配置（mode 为 WILDCARD 时，该字段表示具体视图对象的重命名配置）
	object	否
Name	string	否	视图名
MappedName	string	否	视图映射名
WhereClause	string	否	行过滤，ETL 语法
FilterColumns	array	否	过滤列
	string	否
ShardColumns	array	否	分片列
	string	否
AdbTableSchema	object	否	ADB 数据源的映射信息

返回参数

名称	类型	描述	示例值
	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。	EE205C00-30E4-**-**-87E3A8A2AA0C
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	100
Cost	string	请求耗时，单位为秒。	28
Data	long	请求返回的修改记录 ID。	4

示例

正常返回示例

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": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": 28,
  "Data": 4
}

错误码

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

变更历史

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