All Products
Search
Document Center

Data Management:GetDataTrackOrderDetail

Last Updated:Aug 28, 2026

Retrieves the details of a data tracking 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:GetDataTrackOrderDetail

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

OrderId

integer

Yes

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

4328****

Tid

integer

No

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3***

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The ID of the request.

283C461F-11D8-48AA-B695-DF092DA32AF3

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

ErrorMessage

string

The error message returned if the request failed.

UnknownError

ErrorCode

string

The error code returned if the request failed.

UnknownError

DataTrackOrderDetail

object

The details of the ticket.

DbId

integer

The ID of the database.

3431****

Logic

boolean

Indicates whether the database is a logical database. Valid values:

  • true

  • false

false

DatabaseSearchName

string

The search name of the database.

xxx@yyy:3306

TableNames

array

The names of the tables for which data operations are tracked.

string

The name of a table for which data operations are tracked.

table2

TrackTypes

array

The types of data operations that are tracked.

string

A type of data operation that is tracked.

UPDATE

JobStartTime

string

The start time of the data tracking time range. Format: yyyy-MM-dd HH:mm:ss.

2023-04-23 00:00:00

JobEndTime

string

The end time of the data tracking time range. Format: yyyy-MM-dd HH:mm:ss.

2023-04-23 10:00:00

SchemaName

string

The name of the database.

as_task

JobStatus

string

The status of the data tracking task. Valid values:

  • INIT: The task is being initialized.

  • LISTING: The binary logs are being obtained.

  • LIST_SUCCESS: The binary logs are successfully obtained.

  • DOWNLOADING: The binary logs are being downloaded.

  • DOWNLOAD_FAIL: The binary logs failed to be downloaded.

  • DOWNLOAD_SUCCESS: The binary logs are successfully downloaded.

  • FILTERING: The binary logs are being parsed.

  • FILTER_FAIL: The binary logs failed to be parsed.

  • FILTER_SUCCESS: The binary logs are successfully parsed.

FILTER_SUCCESS

StatusDesc

string

The description of the task status.

searching success

Examples

Success response

JSON format

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DataTrackOrderDetail": {
    "DbId": 0,
    "Logic": false,
    "DatabaseSearchName": "xxx@yyy:3306",
    "TableNames": [
      "table2"
    ],
    "TrackTypes": [
      "UPDATE"
    ],
    "JobStartTime": "2023-04-23 00:00:00",
    "JobEndTime": "2023-04-23 10:00:00",
    "SchemaName": "as_task",
    "JobStatus": "FILTER_SUCCESS",
    "StatusDesc": "searching success"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.