All Products
Search
Document Center

Data Management:GetDatabaseExportOrderDetail

最終更新日:Oct 21, 2024

Queries the details of 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
3***
OrderIdlongYes

The ticket ID. You can call the ListOrders operation to obtain the ticket ID.

821****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

CFD8FE00-36D9-4C1B-940D-65A7B73D9066
DatabaseExportOrderDetailobject

The details of the database export ticket.

Idlong

The ticket ID.

821****
Committerstring

The user who submitted the ticket.

dmsuser
CommitterIdstring

The ID of the user who submitted the ticket. This ID is a user ID and is not the ID of an Alibaba Cloud account.

12***
Commentstring

The business background information of the database export ticket.

test
SearchNamestring

The name that is used to search for the database.

test@xxx.xxx.xxx.xxx:3306
StatusDescstring

The status description of the ticket.

ticket approval
WorkflowStatusDescstring

The status description of the workflow.

ticket approval
KeyInfoobject

The key information about the ticket.

DbIdlong

The database ID.

2583****
DownloadURLstring

The URL that is used to download the export result.

https://oss.xxx.com
AuditDatestring

The time when the ticket was submitted.

2023-04-13 13:44:59
Configobject

The configuration information about the ticket.

DbNamestring

The database name.

dmstest
ExportContentstring

The type of data that was exported. Valid values:

  • DATA: The data of the database was exported.
  • STRUCT: The schema of the database was exported.
  • DATA_STRUCT: The data and schema of the database were exported.
DATA
TargetOptionstring

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

  • SQL
  • CSV
  • XLSX
SQL
ExportTypesarray

The type of schema that was exported.

ExportTypesstring

Valid values:

  • PROCEDURE
  • FUNCTION
  • TRIGGER
  • VIEW
  • EVENT
PROCEDURE
SelectedTablesarray

The tables that were exported from the database.

SelectedTablesstring

The table name.

user_test
SQLExtOptionarray

The extension options of the SQL script.

SQLExtOptionstring

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
Logstring

The execution logs.

2023-04-12 14:58:32:015 Database Dump Start. 2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
  "DatabaseExportOrderDetail": {
    "Id": 0,
    "Committer": "dmsuser",
    "CommitterId": "12***",
    "Comment": "test",
    "SearchName": "test@xxx.xxx.xxx.xxx:3306",
    "StatusDesc": "ticket approval",
    "WorkflowStatusDesc": "ticket approval",
    "KeyInfo": {
      "DbId": 0,
      "DownloadURL": "https://oss.xxx.com",
      "AuditDate": "2023-04-13 13:44:59",
      "Config": {
        "DbName": "dmstest",
        "ExportContent": "DATA",
        "TargetOption": "SQL",
        "ExportTypes": {
          "ExportTypes": [
            "PROCEDURE"
          ]
        },
        "SelectedTables": {
          "SelectedTables": [
            "user_test"
          ]
        },
        "SQLExtOption": {
          "SQLExtOption": [
            "DROP"
          ]
        }
      }
    },
    "Log": "2023-04-12 14:58:32:015 Database Dump Start.\n2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history