Creates a ticket for changing data in Data Management (DMS).
Operation description
For more information about the Normal Data Modify feature, see Change regular data.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dms:CreateDataCorrectOrder | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Comment | string | Yes | The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication. | test |
| RelatedUserList | array | No | The stakeholders of the data change. All stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details. | |
| long | No | The user ID of the stakeholder. All the specified stakeholders can view the ticket details and assist in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBA) are not allowed to view the ticket details. | 51**** | |
| Param | object | Yes | The parameters of the ticket. | |
| Classify | string | No | The reason for the data change. | test |
| EstimateAffectRows | long | Yes | The estimated number of data rows that may be affected by the data change. | 1 |
| ExecSQL | string | No | The SQL statements for data change. Note
| 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 |
| 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 |
| DbItemList | array<object> | Yes | The databases whose data you want to change. | |
| object | No | The information about the databases. | ||
| DbId | long | No | The database ID. The database can be a physical database or a logical database.
| 1860**** |
| Logic | boolean | No | Specifies whether the database is a logical database. Valid values:
| false |
| InstanceId | long | 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 mode in which the data change ticket is executed after the ticket is approved. Valid values:
| COMMITOR |
| AttachmentKey | string | No | The key of the attachment that provides more instructions for the ticket. You can call the GetUserUploadFileJob operation to obtain the attachment key from the value of the AttachmentKey parameter. | order_attachment.txt |
| RealLoginUserUid | string | No | The ID of the Alibaba Cloud account that is used to call the API operation. | 21400447956867**** |
| Tid | long | No | The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID. | 3*** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"CreateOrderResult": [
0
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-11 | The request parameters of the API has changed | View Change Details |