Call CreateFreeLockCorrectOrder to create a lock-free change ticket - Data Management - Alibaba Cloud - Data Management

Creates a lockless change ticket.

Operation description

Only instances with the Security Collaboration control mode are supported. For more information, see Lockless Data Change and Lockless Schema Evolution.
After you call CreateFreeLockCorrectOrder, you must also call SubmitOrderApproval to submit the ticket for approval, ApproveOrder to approve the ticket, and ExecuteDataCorrect to execute the data change.

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:CreateFreeLockCorrectOrder

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Comment	string	Yes	The purpose or objective of the data change, used to 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. Users other than DMS administrators and DBAs who are not stakeholders cannot view the ticket details.
	integer	No	The user ID of a stakeholder. Stakeholders can view and collaborate on the ticket. Non-stakeholders other than administrators and DBAs cannot view the ticket.	51****
Param	object	Yes	The parameters of the ticket.
Classify	string	No	The reason for the data change.	test
ExecSQL	string	Yes	The SQL statements to execute for the data change.	delete from base_user where 1 = 1;
SqlType	string	Yes	The format of the SQL statements for the data change. Valid values: TEXT: text ATTACHMENT: attachment. This value is not supported.	TEXT
AttachmentName	string	No	The key of the attachment that contains the SQL statements for the data change. This parameter is not supported.	test.sql
RollbackSQL	string	No	The SQL statements to roll back the data change.	empty
RollbackAttachmentName	string	No	The key of the attachment that contains the rollback SQL statements.	test_rollback.sql
RollbackSqlType	string	No	The format of the rollback SQL statements. Valid values: TEXT: text ATTACHMENT: attachment. This value is not supported.	TEXT
DbItemList	array<object>	Yes	The databases in which to change data.
	object	No	Database information.
DbId	integer	Yes	The ID of the database. The database can be a physical database or a logical database. To obtain the ID of a physical database, call the ListDatabases or SearchDatabase operation. To obtain the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	1860****
Logic	boolean	Yes	Whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false
ExecMode	string	No	The execution mode after the ticket is approved. Valid values: COMMITOR: The data change is performed by the ticket submitter. AUTO: The data change is automatically performed after the ticket is approved. LAST_AUDITOR: The data change is performed by the last approver of the ticket.	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.	order_attachment.txt
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***
RealLoginUserUid	string	No	The UID of the Alibaba Cloud account of the user who calls this operation.	21400447956867****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	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 failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
CreateOrderResult	array	The ticket ID.
	integer	The ticket ID.	134****

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.