UpdateDIProjectConfig-DataWorks(DataWorks)-阿里云帮助中心

Operation description

DataWorks currently supports default global configuration only for DDL message handling policies in real-time synchronization tasks within synchronization solutions. If a solution contains a real-time synchronization task, the global configuration is read as the default when you configure its DDL handling rules. You can override the target task's default DDL handling rules based on your business requirements. For more information about how to configure a synchronization solution, see Synchronization solutions.

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
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID.	10000
DestinationType	string	Yes	The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.	odps
SourceType	string	No	The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.	mysql
ProjectConfig	string	Yes	The new default global configuration of the synchronization solutions. The value indicates the processing rules of different types of DDL messages. The value must be in the JSON format. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}. Field description: RENAMECOLUMN: renames a column. DROPTABLE: deletes a table. CREATETABLE: creates a table. MODIFYCOLUMN: changes the data type of a column. TRUNCATETABLE: clears a table. DROPCOLUMN: deletes a column. ADDCOLUMN: creates a column. RENAMETABLE: renames a table. DataWorks processes a DDL message of a specific type based on the following rules: WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error. IGNORE: discards the message and does not send it to the destination. CRITICAL: terminates the real-time synchronization task and sets the node status to Failed. NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.	{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0000-ABCD-EFG
Data	object	The information about the modification.
Status	string	Indicates whether the default global configuration of synchronization solutions is modified. Valid values: success fail	success

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Status": "success"
  }
}

Error codes

HTTP status code	Error code	Error message
400	Invalid.DI.Parameter	The parameter is invalid.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.