All Products
Search
Document Center

Data Management:GetDataTrackOrderDetail

Last Updated:Nov 28, 2024

Queries the details of a data tracking 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:GetDataTrackOrderDetailnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

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

4328****
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The ID of the request.

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

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
DataTrackOrderDetailobject

The details of the ticket.

DbIdlong

The ID of the database.

3431****
Logicboolean

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

  • true
  • false
false
DatabaseSearchNamestring

The name that is used to search for the database.

xxx@yyy:3306
TableNamesarray

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

TableNamesstring

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

table2
TrackTypesarray

The types of data operations that are tracked.

TrackTypesstring

A type of data operation that is tracked.

UPDATE
JobStartTimestring

The start time of the time range in which data operations are tracked. The time is in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 00:00:00
JobEndTimestring

The end time of the time range in which data operations are tracked. The time is in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 10:00:00
SchemaNamestring

The name of the database.

as_task
JobStatusstring

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
StatusDescstring

The description of the task status.

searching success

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history