Retrieve Tracking Results via SearchDataTrackResult API - Data Management - Alibaba Cloud - Data Management

Retrieves parsed results from a data tracking task.

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:SearchDataTrackResult

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	420****
FilterStartTime	string	No	The start time for tracking data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.	2023-04-23 00:00:00
FilterEndTime	string	No	The end time for tracking data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.	2023-04-23 10:00:00
FilterTableList	array	No	The names of the tables for which you want to track data operations.
	string	No	The name of a table for which you want to track data operations.	table2
FilterTypeList	array	No	The types of data operations that you want to track.
	string	No	A type of data operation that you want to track.	UPDATE
ColumnFilter	object	No	The condition to filter columns.
ColumnName	string	No	The name of the column.	c_payer_name
Operator	string	No	The operator type for the filter condition. Valid values: EQUAL: retrieves the column with a value equal to the specified value. NOT_EQUAL: retrieves the column with a value not equal to the specified value. IN: retrieves the column with a value in the IN list. BETWEEN: retrieves the column with a value in the specified range. LESS: retrieves the column with a value less than the specified value. MORE: retrieves the column with a value greater than the specified value. NOT_IN: retrieves the column with a value not in the IN list.	EQUAL
Value	string	No	The value used in the filter condition.	1
BetweenStart	string	No	The start value of the filter range. This parameter takes effect only when Operator is set to BETWEEN.	1
BetweenEnd	string	No	The end value of the filter range. This parameter takes effect only when Operator is set to BETWEEN.	10
InList	array	No	The IN list used in the filter condition. This parameter takes effect only when Operator is set to IN or NOT_IN.
	string	No	A value in the IN list. This parameter takes effect only when Operator is set to IN or NOT_IN.	1
Tid	integer	No	The tenant ID. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	62***

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indicates whether the request was successful. 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
TrackResult	object	The parsing result of the data tracking task.
TotalCount	integer	The total number of entries returned.	109
EventList	array<object>	The details of the event logs.
	object	The details of an event log.
DataAfter	array	The data records after the data operations.
	string	A data record after the data operations.	1
DataBefore	array	The data records before the data operations.
	string	A data record before the data operations.	2
EventLength	integer	The length of the event content. Unit: bytes.	4324
EventTimestamp	string	The event time.	2023-04-23 10:25:47
EventType	string	The type of the event. Valid values: WRITE_ROWS: indicates an INSERT operation. UPDATE_ROWS: indicates an UPDATE operation. DELETE_ROWS: indicates a DELETE operation. EXT_WRITE_ROWS: indicates an INSERT operation, which is equivalent to WRITE_ROWS. EXT_UPDATE_ROWS: indicates an UPDATE operation, which is equivalent to UPDATE_ROWS. EXT_DELETE_ROWS: indicates a DELETE operation, which is equivalent to DELETE_ROWS.	UPDATE_ROWS
EventId	integer	The event ID.	1
RollSQL	string	The SQL statements used to roll back the data changes.	-- Timestamp:2023-04-23 10:25:47 #1\r\nUPDATE `dc_test`.`tb_chunk_dml` SET `id`=1 , `gmt_create`='2021-09-30T00:00:00' , `content`='2023-03-30 14:51:50' , `c1`='2023-04-17 13:42:03' , `c_id`=1 , `c13425`='b\\'' , `c432532535`= null , `c1432`= null , `c143243253`= null , `c1432535`= null , `c43125325`= null , `c3425325`= null WHERE (`id`=1)"
TableInfoList	array<object>	The metadata of the tracked tables.
	array<object>	The metadata of a tracked table.
SchemaName	string	The name of the database.	prod_eb_vas
TableName	string	The name of the table.	import_table_test1
Columns	array<object>	The column details.
	object	The details of a column.
ColumnName	string	The name of the column.	basic_platform
ColumnPosition	integer	The position of the column.	1
ColumnType	string	The data type of the column. Examples: BIGINT, INT, and VARCHAR.	BIGINT
Fictive	boolean	Indicates whether the column is a virtual column. Valid values: true false	true
Description	string	The description of the column.	auto-description

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TrackResult": {
    "TotalCount": 109,
    "EventList": [
      {
        "DataAfter": [
          "1"
        ],
        "DataBefore": [
          "2"
        ],
        "EventLength": 4324,
        "EventTimestamp": "2023-04-23 10:25:47",
        "EventType": "UPDATE_ROWS",
        "EventId": 1,
        "RollSQL": "-- Timestamp:2023-04-23 10:25:47 #1\\r\\nUPDATE `dc_test`.`tb_chunk_dml` SET `id`=1 , `gmt_create`='2021-09-30T00:00:00' , `content`='2023-03-30 14:51:50' , `c1`='2023-04-17 13:42:03' , `c_id`=1 , `c13425`='b\\\\'' , `c432532535`= null , `c1432`= null , `c143243253`= null , `c1432535`= null , `c43125325`= null , `c3425325`= null WHERE  (`id`=1)\""
      }
    ],
    "TableInfoList": [
      {
        "SchemaName": "prod_eb_vas",
        "TableName": "import_table_test1",
        "Columns": [
          {
            "ColumnName": "basic_platform",
            "ColumnPosition": 1,
            "ColumnType": "BIGINT",
            "Fictive": true
          }
        ],
        "Description": "auto-description"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.