Creates a ticket.
Operation description
To simplify ticket creation, if you need to create the following types of tickets, call the dedicated operations:
Common data change ticket: Call the CreateDataCorrectOrder operation.
Historical data cleanup ticket: Call the CreateDataCronClearOrder operation.
Data import ticket: Call the CreateDataImportOrder operation.
Lock-free change ticket: Call the CreateFreeLockCorrectOrder operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dms:CreateOrder |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Tid |
integer |
No |
The tenant ID. You can call the GetUserActiveTenant or ListUserTenants operation to obtain this parameter. |
3*** |
| Comment |
string |
Yes |
The description of the ticket. |
test |
| PluginParam |
object |
Yes |
The parameters for creating the ticket. The value is a JSON string. The parameters vary based on the ticket type. For more information, see Supplementary description of PluginParam below the table. |
{PluginParam_test} |
| RelatedUserList |
string |
No |
The IDs of the stakeholders of the ticket. Separate multiple IDs with commas (,). |
user1,user2 |
| PluginType |
string |
Yes |
The ticket type. For valid values, see PluginType parameter description. |
DATA_EXPORT |
| AttachmentKey |
string |
No |
The key of the attachment that is returned after the attachment is uploaded. You can call the GetUserUploadFileJob operation to obtain this parameter. |
test_AttachmentKey |
| RealLoginUserUid |
string |
No |
||
|
No |
Supplementary description of PluginParam
# Schema design
{
"title": "test", // Title
"description": "test", // Description
"dbId": 11****, // Baseline database
"logic": false, // Specifies whether the database is a logical database
"relatedIds": [], // User IDs of change stakeholders
}
# Data export
{
"classify": "Reason category", // Reason category
"dbId": 17****, // ID of the database to export
"exeSQL": "select 1", // Export SQL statement
"logic": false, // Specifies whether the database is a logical database
"ignoreAffectRows": false, // Specifies whether to skip the affected rows check
"affectRows": 1, // Estimated number of affected rows
"ignoreAffectRowsReason": "" // Reason for skipping the affected rows check
}
# Permission ticket
{
"seconds": xxx, // Permission duration, in seconds
"permType": xx, // Permission type: 1-Query, 2-Export, 4-Change. To apply for multiple permission types, add the values together. For example, the value for query and export permissions is 3.
"resources": [{
"dbId": xxx, // Database ID
"instanceId": xxx // Instance ID
"logic": xxx // Specifies whether the database is a logical database
"tableName": xxx // Table name
"tableId": xxx // Table ID
"columnName": xxx // Column name
}],
"type": "xx" // INSTANT, DB, or TABLE
}
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| CreateOrderResult |
object |
||
| OrderIds |
array |
The information about the tickets that are created. |
|
|
integer |
The ticket ID. |
12*** |
|
| RequestId |
string |
The request ID. |
427688B8-ADFB-4C4E-9D45-EF5C1FD6**** |
| ErrorCode |
string |
The error code. |
UnknownError |
| ErrorMessage |
string |
The error message. |
UnknownError |
| Success |
boolean |
Indicates whether the request is successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"CreateOrderResult": {
"OrderIds": [
0
]
},
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.