Use GetDataExportOrderDetail to query data export ticket details - Data Management - Alibaba Cloud - Data Management

Queries the details of a data 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:GetDataExportOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	3***
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	818****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
DataExportOrderDetail	object	The information about the data export ticket.
KeyInfo	object	The status information.
PreCheckId	integer	The precheck ID.	6393****
JobStatus	string	The state of the data export ticket. Valid values: PRE_CHECKING: The ticket was being prechecked. PRE_CHECK_SUCCESS: The ticket passed the precheck. PRE_CHECK_FAIL: The ticket failed the precheck. WAITING_APPLY_AUDIT: The ticket was to be submitted for approval. APPLY_AUDIT_SUCCESS: The ticket was submitted for approval. ENABLE_EXPORT: The ticket was approved. Data can be exported. WAITING_EXPORT: Data was to be scheduled for export. DOING_EXPORT: Data was being exported. EXPORT_FAIL: Data failed to be exported. EXPORT_SUCCESS: Data was exported.	EXPORT_SUCCESS
JobId	integer	The export task ID.	1385****
OrderDetail	object	The details of the ticket.
DbId	integer	The ID of the database from which data was exported.	3733****
Database	string	The name of the database from which data was exported.	xxx@xxx:3306
Classify	string	The category of the reason for the data export.	text
ExeSQL	string	The SQL statement that was executed to export data.	SELECT * FROM DMS_test LIMIT 20;
Logic	boolean	Indicates whether the database is a logical database.	false
ActualAffectRows	integer	The number of rows that were affected by the SQL statement.	1
IgnoreAffectRows	boolean	Indicates whether the affected rows are skipped.	false
IgnoreAffectRowsReason	string	The reason why the affected rows are skipped.	empty
EnvType	string	The type of the environment to which the database belongs.	test
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataExportOrderDetail": {
    "KeyInfo": {
      "PreCheckId": 0,
      "JobStatus": "EXPORT_SUCCESS",
      "JobId": 0
    },
    "OrderDetail": {
      "DbId": 0,
      "Database": "xxx@xxx:3306",
      "Classify": "text",
      "ExeSQL": "SELECT * FROM DMS_test\n LIMIT 20;",
      "Logic": false,
      "ActualAffectRows": 1,
      "IgnoreAffectRows": false,
      "IgnoreAffectRowsReason": "empty",
      "EnvType": "test"
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.