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
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 | 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 to be affected by the data change. | 1 |
ExecSQL | string | No | The SQL statements that you want to execute to change data. Note
This parameter is required if you set the SqlType parameter to TEXT.
| 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 the AttachmentKey parameter. Note
This parameter is required if you set the SqlType parameter to ATTACHMENT.
| test.sql |
RollbackSQL | string | No | The SQL statements used to roll back the data change. Note
This parameter is required if you set the RollbackSqlType parameter 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 the attachment key from the value of the AttachmentKey parameter. Note
This parameter is required if you set the RollbackSqlType parameter 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 in which you want to change data. | |
object | No | |||
DbId | long | Yes | The ID of the database. The database can be a physical database or a logical database.
| 1860**** |
Logic | boolean | Yes | Specifies whether the database is a logical database. Valid values:
| false |
ExecMode | string | No | The execution mode of the ticket 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 |
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
JSON
format
{
"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 |