Creates a ticket to export an SQL result set.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ParentId | long | No | The ID of the parent ticket. | 877**** |
| Comment | string | Yes | The purpose or objective of the ticket. This parameter helps reduce unnecessary communication. | business_test |
| 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. | order_attachment.txt |
| RelatedUserList | array | No | The stakeholders involved in this operation. | |
| long | No | The user ID of the stakeholder. This ID is a user ID and is not the ID of an Alibaba Cloud account. The stakeholders involved in this export. All the specified stakeholders can view the ticket details and take part in the approval process. Irrelevant users other than Data Management (DMS) administrators and database administrators (DBAs) are not allowed to view the ticket details. | 2452345113**** | |
| PluginParam | object | Yes | The parameters of the ticket. | |
| AffectRows | long | Yes | The estimated number of data rows to be affected. | 1 |
| Classify | string | Yes | The reason for the export ticket. | test |
| InstanceId | long | Yes | The instance ID. | 132**** |
| DbId | long | Yes | The database ID. | 18**** |
| Logic | boolean | Yes | Specifies whether the database is a logical database. Valid values:
Note
If you set this parameter to true, the database that you specify must be a logical database.
| true |
| IgnoreAffectRows | boolean | Yes | Specifies whether to skip verification. Valid values:
| true |
| IgnoreAffectRowsReason | string | No | The reason for skipping verification. This parameter is required if you set IgnoreAffectRows to true. | Test only, does not affect the business, and does not require verification. |
| ExeSQL | string | Yes | The SQL statements that can be executed. | SELECT * FROM DMS_test LIMIT 20; |
| Watermark | object | No | The information about the watermarks. | |
| WatermarkTypes | array | No | The methods in which the watermark is embedded. | |
| string | No | The method in which the watermark is embedded. Valid values:
For more information about watermarks, see Use data watermarks. | DATA | |
| Keys | array | No | One or more primary keys or unique keys. | |
| string | No | The primary keys or unique keys. Separate multiple keys with commas (,). | ID | |
| ColumnName | string | No | The field into which the watermark is to be embedded. | user_number |
| DataWatermark | string | No | The information to be embedded as a watermark into data. | test |
| FileWatermark | string | No | The information to be embedded as a watermark into files. | test |
| Tid | long | No | The tenant ID. Note
To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
| 3*** |
| RealLoginUserUid | string | No | The UID of the Alibaba Cloud account that actually calls the API. | 21400447956867**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"CreateOrderResult": {
"CreateOrderResult": [
0
]
},
"Success": true
}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 |