All Products
Search
Document Center

Data Management:CreateDatabaseExportOrder

Last Updated:Feb 22, 2024

Creates a database export ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ParentIdlongNo

The ID of the parent ticket.

877****
CommentstringYes

The purpose or objective of the ticket. This parameter helps reduce unnecessary communication.

document_test
AttachmentKeystringNo

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
PluginParamobjectYes

The parameters of the ticket.

ClassifystringYes

The reason for the database export.

document_test
DbIdlongYes

The database ID.

17****
InstanceIdlongYes

The instance ID.

137****
LogicbooleanYes

Specifies whether the database is a logical database. Valid values:

  • true
  • false
true
ConfigobjectYes

The configurations for database export.

SQLExtOptionarrayYes

The extension options of the SQL script. You can leave this parameter empty.

stringNo

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
DataOptionarrayYes

The export options for big data. The options are used to filter the big data to be exported. You can leave this parameter empty.

stringNo

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
ExportContentstringYes

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
ExportTypesarrayNo

The types of schemas that you want to export.

stringNo

The type of schema that you want to export. Valid values:

  • PROCEDURE
  • FUNCTION
  • TRIGGER
  • VIEW
  • EVENT
PROCEDURE
SelectedTablesarrayNo

The tables that you want to export.

stringNo

The table that you want to export.

dmstest_table
TablesobjectNo

The conditions used to filter the tables to be exported.

stringNo

The condition used to filter the tables to be exported.

where 1=1
TargetOptionstringYes

The format in which the database is exported. Valid values:

  • SQL
  • CSV
  • XLSX
SQL
SearchNamestringYes

The name that is used to search for the database.

test@xxx.xxx.xxx.xxx:3306
RelatedUserListarrayNo

The stakeholders involved in this operation.

longNo

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****
TidlongNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

The error code returned.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
CreateOrderResultarray

The information about the ticket.

long

The ticket ID.

12***
Successboolean

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 timeSummary of changesOperation
No change history