All Products
Search
Document Center

Data Management:GetDataExportOrderDetail

Last Updated:Nov 28, 2024

Queries the information about a data 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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetDataExportOrderDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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.
-1
OrderIdlongYes

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

123456

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
DataExportOrderDetailobject

The information about the data export ticket.

KeyInfoobject

The information about the ticket.

PreCheckIdlong

The precheck ID.

123
JobStatusstring

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 to pass the prechecked.
  • 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
OrderDetailobject

The details of the ticket.

DbIdinteger

The ID of the database from which data was exported.

123
Databasestring

The name of the database from which data was exported.

xxx@xxx:3306
Classifystring

The category of the reason for the data export.

text
ExeSQLstring

The SQL statement that was executed to export data.

select 1
Logicboolean

Indicates whether the database is a logical database.

false
ActualAffectRowslong

The number of rows that were affected by the SQL statement.

1
IgnoreAffectRowsboolean

Indicates whether the affected rows are skipped.

false
IgnoreAffectRowsReasonstring

The reason why the affected rows are skipped.

empty
EnvTypestring

The type of the environment to which the database belongs.

test
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values: Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataExportOrderDetail": {
    "KeyInfo": {
      "PreCheckId": 123,
      "JobStatus": "EXPORT_SUCCESS"
    },
    "OrderDetail": {
      "DbId": 123,
      "Database": "xxx@xxx:3306",
      "Classify": "text",
      "ExeSQL": "select 1",
      "Logic": false,
      "ActualAffectRows": 1,
      "IgnoreAffectRows": false,
      "IgnoreAffectRowsReason": "empty",
      "EnvType": "test"
    }
  },
  "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
2024-10-15The response structure of the API has changedView Change Details