Retrieves the details of a data tracking ticket.
Try it now
Test
RAM authorization
|
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 |
| 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:
|
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:
|
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.