Automate Data Change Tickets with CreateDataCorrectOrder - Data Management - Alibaba Cloud - Data Management

Creates a data change ticket in Data Management (DMS).

Operation description

For more information about the Normal Data Modify feature, see Change regular data.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:CreateDataCorrectOrder

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Comment	string	Yes	The purpose or objective of the data change, which helps reduce unnecessary communication.	test
RelatedUserList	array	No	The stakeholders of the data change. Stakeholders can view the ticket details and assist in the approval process. Other users, except DMS administrators and database administrators (DBAs), cannot view the ticket details.
	integer	No	The user ID of the stakeholder. Specified stakeholders can view the ticket details and assist in the approval process. Other users, except Data Management (DMS) administrators and database administrators (DBAs), cannot view the ticket details.	51****
Param	object	Yes	The parameters of the ticket.
Classify	string	No	The reason for the data change.	test
EstimateAffectRows	integer	Yes	The estimated number of data rows affected by the data change.	1
ExecSQL	string	No	The SQL statements for data change. Note This parameter is required if you set SqlType to TEXT. The size of the SQL statement cannot exceed 15 MB.	update base_user set id = 1 where id = 1;
SqlType	string	Yes	The format of the SQL statements used to change data. Valid values: TEXT ATTACHMENT	TEXT
AttachmentName	string	No	The key of the attachment that contains the SQL statements used to change data. You can call the GetUserUploadFileJob operation to obtain the attachment key from the value of AttachmentKey. Note This parameter is required if you set SqlType to ATTACHMENT.	test.sql
RollbackSQL	string	No	The SQL statements for rolling back the data change. Note This parameter is required if you set RollbackSqlType to TEXT.	update base_user set id = 1 where id = 1;
RollbackAttachmentName	string	No	The key of the attachment that contains the SQL statements used to roll back the data change. You can call the GetUserUploadFileJob operation to obtain the attachment key from the value of AttachmentKey. Note This parameter is required if you set RollbackSqlType to ATTACHMENT.	test_rollback.sql
RollbackSqlType	string	No	The format of the SQL statements used to roll back the data change. Valid values: TEXT ATTACHMENT	TEXT
DbItemList	array<object>	Yes	The databases whose data you want to change.
	object	No	The information about the databases.
DbId	integer	No	The database ID. The database can be a physical database or a logical database. To query the ID of a physical database, call the ListDatabases or SearchDatabase operation. To query the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	1860****
Logic	boolean	No	Specifies whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false
InstanceId	integer	No	The instance ID. You can call the ListInstances or GetInstance operation to query the instance ID. Note The instance change feature is supported only by ApsaraDB RDS for MySQL instances, PolarDB for MySQL clusters, and AnalyticDB for MySQL clusters.	1860****
ExecMode	string	No	The execution mode for the data change ticket after approval. Valid values: COMMITOR: The ticket is executed by the submitter. AUTO: The ticket is automatically executed after approval. LAST_AUDITOR: The ticket is executed by the last approver.	COMMITOR
AttachmentKey	string	No	The key of the attachment that provides additional instructions for the ticket. You can call the GetUserUploadFileJob operation to obtain the attachment key from the AttachmentKey parameter.	order_attachment.txt
RealLoginUserUid	string	No	The ID of the Alibaba Cloud account used to call the API operation.	21400447956867****
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request fails.	UnknownError
ErrorCode	string	The error code returned if the request fails.	UnknownError
CreateOrderResult	array	The IDs of the tickets.
	integer	The ID of the ticket.	142****

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.