GetDatabaseExportOrderDetail - Data Management - Alibaba Cloud ドキュメントセンター

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.

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:GetDatabaseExportOrderDetail	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	CFD8FE00-36D9-4C1B-940D-65A7B73D9066
DatabaseExportOrderDetail	object	The details of the database export ticket.
Id	long	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 ID is a user ID and is not the ID of an Alibaba Cloud account.	12***
Comment	string	The business background information of the database export ticket.	test
SearchName	string	The name that is used to search for the database.	test@xxx.xxx.xxx.xxx:3306
StatusDesc	string	The status description of the ticket.	ticket approval
WorkflowStatusDesc	string	The status description of the workflow.	ticket approval
KeyInfo	object	The key information about the ticket.
DbId	long	The database ID.	2583****
DownloadURL	string	The URL that is used to download 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 information about 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 format in which the database was exported. Valid values: SQL CSV XLSX	SQL
ExportTypes	array	The type of schema that was exported.
ExportTypes	string	Valid values: PROCEDURE FUNCTION TRIGGER VIEW EVENT	PROCEDURE
SelectedTables	array	The tables that were exported from the database.
SelectedTables	string	The table name.	user_test
SQLExtOption	array	The extension options of the SQL script.
SQLExtOption	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 is 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	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 time	Summary of changes	Operation

No change history