All Products
Search
Document Center

Data Management:CreateDataCorrectOrder

Last Updated:Oct 21, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CommentstringYes

The purpose or objective of the data change. This parameter is used to help reduce unnecessary communication.

test
RelatedUserListarrayNo

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.

longNo
51****
ParamobjectYes

The parameters of the ticket.

ClassifystringNo

The reason for the data change.

test
EstimateAffectRowslongYes

The estimated number of data rows to be affected by the data change.

1
ExecSQLstringNo

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;
SqlTypestringYes

The format of the SQL statements used to change data. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
TEXT
AttachmentNamestringNo

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
RollbackSQLstringNo

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;
RollbackAttachmentNamestringNo

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
RollbackSqlTypestringNo

The format of the SQL statements used to roll back the data change. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
TEXT
DbItemListarray<object>Yes

The databases in which you want to change data.

objectNo
DbIdlongYes

The ID of the database. The database can be a physical database or a logical database.

1860****
LogicbooleanYes

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
ExecModestringNo

The execution mode of the ticket after the ticket is approved. Valid values:

  • COMMITOR: The data change is performed by the user who submits the ticket.
  • 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
AttachmentKeystringNo

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
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrorMessagestring

The error message returned if the request fails.

UnknownError
ErrorCodestring

The error code returned if the request fails.

UnknownError
CreateOrderResultarray

The IDs of the tickets.

OrderIdslong

The ID of the ticket.

142****

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 timeSummary of changesOperation
2024-07-11The request parameters of the API has changedView Change Details