CreateDatabaseExportOrder - Data Management

Creates a database export ticket.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:CreateDatabaseExportOrder		All Resources ``	none	none

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.	document_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
PluginParam	object	Yes	The parameters of the ticket.
Classify	string	Yes	The reason for the database export.	document_test
DbId	long	Yes	The database ID.	17****
InstanceId	long	Yes	The instance ID.	137****
Logic	boolean	Yes	Specifies whether the database is a logical database. Valid values: true false	true
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 is compressed to 5 MB.	DROP
DataOption	array	Yes	The export options for big data. The options are used to filter the big 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 that is used to search for the database.	test@xxx.xxx.xxx.xxx:3306
RelatedUserList	array	No	The stakeholders involved in this operation.
	long	No	The user ID of the stakeholder. 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****
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***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID. You can use the ID 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	array	The information about the ticket.
CreateOrderResult	long	The ticket ID.	12***
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

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

No change history