Create a database export ticket by calling CreateDatabaseExportOrder - Data Management - Alibaba Cloud - Data Management

Creates a database export ticket.

Operation description

This operation supports only database instances in Security Collaboration control 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:CreateDatabaseExportOrder

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 or objective of the ticket. Helps reduce unnecessary communication.	Documentation test
AttachmentKey	string	No	The attachment key that provides additional instructions for the ticket. Call the GetUserUploadFileJob operation to obtain the key.	order_attachment.txt
PluginParam	object	Yes	The parameters of the ticket.
Classify	string	Yes	The reason for the database export.	Documentation test
DbId	integer	Yes	The database ID.	17****
InstanceId	integer	Yes	The instance ID.	137****
Logic	boolean	Yes	Whether the database is a logical database. Valid values: true false	false
Config	object	Yes	The configurations for database export.
SQLExtOption	array	Yes	The extension options of the SQL script. You can leave this parameter empty.
	string	No	The extension option of the SQL script. Valid values: DROP: A DROP TABLE statement is generated before the CREATE statement. TRUNCATE: A TRUNCATE TABLE statement is generated before an INSERT statement. COMPRESS: The values to be inserted by an INSERT statement are compressed to 5 MB.	DROP
DataOption	array	Yes	The export options for big data, used to filter the data to be exported. You can leave this parameter empty.
	string	No	The export option for big data. Valid values: BLOB: exports big data of types such as BLOG and TINYBLOB. TEXT: exports big data of types such as TEXT and TINYTEXT. BINARY: exports big data of types such as BINARY and VARBINARY.	BLOB
ExportContent	string	Yes	The type of data that you want to export. Valid values: DATA: The data of the database is exported. STRUCT: The schema of the database is exported. DATA_STRUCT: The data and schema of the database are exported.	DATA
ExportTypes	array	No	The types of schemas that you want to export.
	string	No	The type of schema that you want to export. Valid values: PROCEDURE FUNCTION TRIGGER VIEW EVENT	PROCEDURE
SelectedTables	array	No	The tables that you want to export.
	string	No	The table that you want to export.	dmstest_table
Tables	object	No	The conditions used to filter the tables to be exported.
	string	No	The condition used to filter the tables to be exported.	where 1=1
TargetOption	string	Yes	The format in which the database is exported. Valid values: SQL CSV XLSX	SQL
SearchName	string	Yes	The name used to search for the database.	test@xxx.xxx.xxx.xxx:3306
RelatedUserList	array	No	The stakeholders involved in this operation.
	integer	No	The user ID of a stakeholder in this export. Specified stakeholders can view ticket details and participate in the approval process. Other users, except Data Management (DMS) administrators and database administrators (DBAs), cannot view ticket details.	2452345113****
Tid	integer	No	The tenant ID. Note To view the tenant ID, hover 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***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which can be used to query logs and troubleshoot issues.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
CreateOrderResult	object
CreateOrderResult	array	The information about the ticket.
	integer	The ticket ID.	12***
Success	boolean	Whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "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.