CreateDataExportOrder - Create SQL result set export ticket - Data Management

Creates a ticket to export an SQL result set.

Operation description

This operation applies only to database instances in Security Collaboration mode.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:CreateDataExportOrder

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentId	integer	No	The ID of the parent ticket.	877****
Comment	string	Yes	The purpose of the ticket. Helps reduce unnecessary communication.	Business testing.
AttachmentKey	string	No	The attachment key for additional ticket instructions. Call GetUserUploadFileJob to obtain the key.	order_attachment.txt
RelatedUserList	array	No	The stakeholders involved in this operation.
	integer	No	The DMS user ID (not the Alibaba Cloud account ID) of a stakeholder. Specified stakeholders can view the ticket and participate in the approval process. Only DMS administrators and DBAs can view tickets beyond the specified stakeholders.	2452345113****
PluginParam	object	Yes	The parameters of the ticket.
AffectRows	integer	Yes	The estimated number of data rows to be affected.	1
Classify	string	Yes	The reason for the export ticket.	Test
InstanceId	integer	Yes	The instance ID.	132****
DbId	integer	Yes	The database ID.	18****
Logic	boolean	Yes	Whether the database is a logical database. Valid values: true false Note If set to true, the specified database must be a logical database.	true
IgnoreAffectRows	boolean	Yes	Whether to skip verification. Valid values: true false	true
IgnoreAffectRowsReason	string	No	The reason for skipping verification. Required if IgnoreAffectRows is set to true.	Testing only. No impact on business. No verification needed.
ExeSQL	string	Yes	The SQL statements to execute.	SELECT * FROM DMS_test LIMIT 20;
Watermark	object	No	The watermark configuration.
WatermarkTypes	array	No	The watermark embedding methods.
	string	No	The watermark embedding method. Valid values: DATA: embeds identification into data. FILE: embeds identification into files. 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 for watermark embedding.	user_number
DataWatermark	string	No	The data watermark content.	Test
FileWatermark	string	No	The file watermark content.	Test
Tid	integer	No	The tenant ID. Note To find the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. View information about the current tenant.	3***
RealLoginUserUid	string	No	The UID of the Alibaba Cloud account that calls the API.	21400447956867****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID for log queries and troubleshooting.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message if the request failed.	UnknownError
CreateOrderResult	object
CreateOrderResult	array	The content of the ticket.
	integer	The ticket ID.	819****
Success	boolean	Whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "CreateOrderResult": {
    "CreateOrderResult": [
      0
    ]
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.