Query database export ticket details by calling GetDatabaseExportOrderDetail - Data Management - Alibaba Cloud - Data Management

Retrieves the details of a database export ticket.

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:GetDatabaseExportOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	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***
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to obtain the ticket ID.	821****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which can be used to query logs and troubleshoot issues.	CFD8FE00-36D9-4C1B-940D-65A7B73D9066
DatabaseExportOrderDetail	object	The details of the database export ticket.
Id	integer	The ticket ID.	821****
Committer	string	The user who submitted the ticket.	dmsuser
CommitterId	string	The ID of the user who submitted the ticket. This is a DMS user ID, not an Alibaba Cloud account ID.	12***
Comment	string	The business background of the database export ticket.	test
SearchName	string	The name used to search for the database.	test@xxx.xxx.xxx.xxx:3306
StatusDesc	string	The status description of the ticket.	Ticket approval in progress.
WorkflowStatusDesc	string	The status description of the workflow.	Ticket approval in progress.
KeyInfo	object	The key information about the ticket.
DbId	integer	The database ID.	2583****
DownloadURL	string	The URL for downloading the export result.	https://oss.xxx.com
AuditDate	string	The time when the ticket was submitted.	2023-04-13 13:44:59
Config	object	The configuration of the ticket.
DbName	string	The database name.	dmstest
ExportContent	string	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
TargetOption	string	The export format. Valid values: SQL CSV XLSX	SQL
ExportTypes	object
ExportTypes	array	The type of schema that was exported.
	string	Valid values: PROCEDURE FUNCTION TRIGGER VIEW EVENT	PROCEDURE
SelectedTables	object
SelectedTables	array	The tables that were exported from the database.
	string	The table name.	user_test
SQLExtOption	object
SQLExtOption	array	The extension options of the SQL script.
	string	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
Log	string	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
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "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 in progress.",
    "WorkflowStatusDesc": "Ticket approval in progress.",
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.