CreateProjectModifyRecords-阿里云帮助中心

This operation modifies the objects of a data migration or data synchronization task that is running, failed, or paused.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the data migration or data synchronization task.	np_fe****
Databases	array<object>	No	A list of database objects.
	array<object>	No
Id	string	No	The ID of the database.	db_id
Name	string	No	The name of the database.	db_name
MappedName	string	No	The mapped name of the database.	mapped_db
Tables	array<object>	No	The configuration for transferring table objects in the current database. When Mode is set to WILDCARD, this parameter specifies the blacklist or whitelist configuration, which is shared by tables and views.
	array<object>	No
Name	string	No	The name of the table.	table_name
MappedName	string	No	The mapped name of the table.	mapped_table
Id	string	No	The ID of the table.	table_id
WhereClause	string	No	The `WHERE` clause of a standard SQL statement used to configure row filtering.	id<1
FilterColumns	array	No	A collection of filtered columns.
	string	No	A filtered column.	col
ShardColumns	array	No	A collection of sharding key columns.
	string	No	A sharding key column.	col1
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No	A collection of primary key columns.
	string	No	A primary key column.	pk
DistributedKeys	array	No	A collection of distribution key columns.
	string	No	A distribution key column.	col2
PartitionStatement	string	No	The partition filter expression.	PARTITION BY VALUE('id')
PartitionLifeCycle	string	No	The lifecycle of the table.	30
ObkvPartitionConfig	object	No	The partition configuration for Hbase mode. This is used only when migrating data to OBKV.
PartitionType	string	No
VirtualColumn	string	No
PartitionSize	integer	No
Views	array<object>	No	A list of configurations for transferring view objects in the current database.
	array<object>	No
Name	string	No	The name of the view.	view_name
MappedName	string	No	The mapped name of the view.	mapped_view
Id	string	No	The ID of the view.	view_id
WhereClause	string	No	The `WHERE` clause of a standard SQL statement used to configure row filtering.	id<1
FilterColumns	array	No	A collection of filtered columns.
	string	No	A filtered column.	col
ShardColumns	array	No	A collection of sharding key columns.
	string	No	A sharding key column.	col1
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No	A collection of primary key columns.
	string	No	A primary key column.	pk
DistributedKeys	array	No	A collection of distribution key columns.
	string	No	A distribution key column.	col2
PartitionStatement	string	No	The partition filter expression.	PARTITION BY VALUE('id')
PartitionLifeCycle	string	No	The lifecycle of the table.	30
SpecificTables	array<object>	No	A collection of configurations for specific table objects. When `mode` is `WILDCARD`, this parameter specifies the renaming and row filtering configurations for specific table objects.
	array<object>	No
Name	string	No	The name of the table.	table_name
MappedName	string	No	The mapped name of the table.	mapped_table
Id	string	No	The ID of the table.	table_id
WhereClause	string	No	The `WHERE` clause of a standard SQL statement used to configure row filtering.	id<1
FilterColumns	array	No	A collection of filtered columns.
	string	No	A filtered column.	col
ShardColumns	array	No	A collection of sharding key columns.
	string	No	A sharding key column.	col1
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No	A collection of primary key columns.
	string	No	A primary key column.	pk
DistributedKeys	array	No	A collection of distribution key columns.
	string	No	A distribution key column.	col2
PartitionStatement	string	No	The partition filter expression.	PARTITION BY VALUE('id')
PartitionLifeCycle	string	No	The lifecycle of the table.	30
SpecificViews	array<object>	No	A list of configurations for specific view objects. When `mode` is `WILDCARD`, this parameter specifies the renaming configuration for specific view objects.
	array<object>	No
Name	string	No	The name of the view.	view_name
MappedName	string	No	The mapped name of the view.	mapped_view
Id	string	No	The ID of the view.	view_id
WhereClause	string	No	The `WHERE` clause of a standard SQL statement used to configure row filtering.	id <1
FilterColumns	array	No	A collection of filtered columns.
	string	No	A filtered column.	col
ShardColumns	array	No	A collection of sharding key columns.
	string	No	A sharding key column.	col1
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No	A collection of primary key columns.
	string	No	A primary key column.	pk
DistributedKeys	array	No	A collection of distribution key columns.
	string	No	A distribution key column.	col2
PartitionStatement	string	No	The partition filter expression.	PARTITION BY VALUE('id')
PartitionLifeCycle	string	No	The lifecycle of the table.	30
TransferMapping	object	No	The list of transfer objects. This is required when you modify matching rules.
Mode	string	No	The mapping mode for transfer objects. Valid values: SPECIFIC (specify objects), WILDCARD (use matching rules), and COMPLEX (use a mix of rules).	SPCEIFIC
Databases	array<object>	No	Database information.
	array<object>	No
Id	string	No	The database ID.
Name	string	No	The database name.
MappedName	string	No	The mapped database name.
ClusterName	string	No	The mapped object cluster. (Deprecated)
TenantName	string	No	The mapped object tenant. (Deprecated)
Tables	array<object>	No	The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No	The table ID.
WhereClause	string	No	Row filtering. Uses extract, transform, and load (ETL) syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
ObkvPartitionConfig	object	No	The partition configuration for Hbase mode. This is used only when migrating data to OBKV.
PartitionType	string	No
VirtualColumn	string	No
PartitionSize	integer	No
Views	array<object>	No	The configuration for view objects to transfer in the current database.
	array<object>	No
Name	string	No	The view name.
MappedName	string	No	The mapped view name.
Id	string	No
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificTables	array<object>	No	The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificViews	array<object>	No	The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.
	array<object>	No
Name	string	No	The view name.
MappedName	string	No	The mapped view name.
Id	string	No
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
DatabasesBlack	array<object>	No	Matching rule mode: Database object blacklist.
	array<object>	No
Id	string	No
Name	string	No	The database name.
MappedName	string	No	The mapped database name.
ClusterName	string	No	The mapped object cluster. (Deprecated)
TenantName	string	No	The mapped object tenant. (Deprecated)
Tables	array<object>	No	The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No	The table ID.
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
Views	array<object>	No	The configuration for view objects to transfer in the current database.
	array<object>	No
Name	string	No	The view name.
MappedName	string	No	The mapped view name.
Id	string	No	The view ID.
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificTables	array<object>	No	The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.
	array<object>	No
Name	string	No	The table name.
Id	string	No	The table ID.
MappedName	string	No	The mapped table name.
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificViews	array<object>	No	The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No	The view ID.
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
TableAndViewWhiteList	array	No	Matching rule mode: Wildcard whitelist for tables and views.
	string	No
TableAndViewBlackList	array	No	Matching rule mode: Wildcard blacklist for tables and views.
	string	No
WhiteTableRules	array<object>	No	Table whitelist rules.
	array<object>	No
SchemaMapping	object	No	Schema mapping.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
ObjectMapping	object	No	The object mapping under the schema.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
WhiteViewRules	array<object>	No	View whitelist rules.
	array<object>	No
SchemaMapping	object	No	Schema mapping.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
ObjectMapping	object	No	The object mapping under the schema.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
BlackTableRules	array<object>	No	Table blacklist rules.
	array<object>	No
SchemaMapping	object	No	Schema mapping.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
ObjectMapping	object	No	The object mapping under the schema.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
BlackViewRules	array<object>	No	View blacklist rules.
	array<object>	No
SchemaMapping	object	No	Schema mapping.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
ObjectMapping	object	No	The object mapping under the schema.
Name	string	No	The object name.
MappedName	string	No	The mapped object name.
Schemas	array<object>	No	Precise database and table object settings.
	array<object>	No
Id	string	No	The database ID.
Name	string	No	The database name.
MappedName	string	No	The mapped database name.
ClusterName	string	No	The mapped object cluster. (Deprecated)
TenantName	string	No	The mapped object tenant. (Deprecated)
Tables	array<object>	No	The configuration for table objects to transfer in the current database. When mode is WILDCARD, this field specifies the blacklist or whitelist configuration, which is shared by tables and views.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No	The table ID.
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
ObkvPartitionConfig	object	No	The partition configuration for Hbase mode. This is used only when migrating data to OBKV.
PartitionType	string	No
VirtualColumn	string	No
PartitionSize	integer	No
Views	array<object>	No	The configuration for view objects to transfer in the current database.
	array<object>	No
Name	string	No	The view name.
MappedName	string	No	The mapped view name.
Id	string	No
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificTables	array<object>	No	The configuration for specific table objects. When mode is WILDCARD, this field specifies the renaming and row filtering configurations for specific table objects.
	array<object>	No
Name	string	No	The table name.
MappedName	string	No	The mapped table name.
Id	string	No
WhereClause	string	No	Row filtering. Uses ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No
SpecificViews	array<object>	No	The configuration for specific view objects. When mode is WILDCARD, this field specifies the renaming configuration for specific view objects.
	array<object>	No
Name	string	No	The view name.
MappedName	string	No	The mapped view name.
Id	string	No
WhereClause	string	No	Row filtering. ETL syntax.
FilterColumns	array	No	The columns to filter.
	string	No
ShardColumns	array	No	The sharding columns.
	string	No
AdbTableSchema	object	No	The mapping information for the ADB data source.
PrimaryKeys	array	No
	string	No
DistributedKeys	array	No
	string	No
PartitionStatement	string	No
PartitionLifeCycle	string	No

Response elements

Element	Type	Description	Example
	object	The response.
Success	boolean	Indicates whether the call was successful.	true
ErrorDetail	object	The error details.
Code	string	The error code (old).	CM-RESOAT1111
Level	string	The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.	ERROR
Message	string	The error description (old).	A system error occurred.
ExtraContext	object	Used to fill placeholders in the Message.
	any	Used to fill placeholders in the Message.	null
MessageMcmsKey	string	The key of the error message.	null
MessageMcmsContext	object	Used to fill placeholders in MessageMcmsKey.
	string	Used to fill placeholders in MessageMcmsKey.	null
Reason	string	The cause of the error.	null
ReasonMcmsKey	string	The key for the cause of the error.	null
ReasonMcmsContext	object	The context for the cause of the error.
	string	The context for the cause of the error.	null
Proposal	string	The suggested solution (new).	Contact the administrator.
ProposalMcmsKey	string	The key for the suggested solution.	null
ProposalMcmsContext	object	The context for the suggested solution.
	string	The context for the suggested solution.	null
UpstreamErrorDetail	any	The upstream error details, used for handling HTTP requests.	null
Code	string	The error code.	INNER_ERROR
Message	string	The error description.	A system error occurred.
Advice	string	The suggested solution.	Contact the administrator.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
PageNumber	integer	The page number. This is effective for paged queries.	1
PageSize	integer	The page size. This is effective for paged queries.	10
TotalCount	integer	The total count. This is effective for paged queries.	100
Cost	string	The request duration, in seconds.	28
Data	integer	The ID of the modification record returned by the request.	4

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.