All Products
Search
Document Center

Data Management:SearchDataTrackResult

Last Updated:Nov 28, 2024

Searches for the parsing result of a data tracking task.

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:SearchDataTrackResultnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

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

420****
FilterStartTimestringNo

The start time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 00:00:00
FilterEndTimestringNo

The end time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 10:00:00
FilterTableListarrayNo

The names of the tables for which you want to track data operations.

stringNo

The name of a table for which you want to track data operations.

table2
FilterTypeListarrayNo

The types of data operations that you want to track.

stringNo

A type of data operation that you want to track.

UPDATE
ColumnFilterobjectNo

The condition to filter columns.

ColumnNamestringNo

The name of the column.

c_payer_name
OperatorstringNo

The type of the operator used to configure the filter condition. Valid values:

  • EQUAL: retrieves the column whose value is equal to the specified value.
  • NOT_EQUAL: retrieves the column whose value is not equal to the specified value.
  • IN: retrieves the column whose value is in the IN list.
  • BETWEEN: retrieves the column whose value is in the specified range.
  • LESS: retrieves the column whose value is less than the specified value.
  • MORE: retrieves the column whose value is greater than the specified value.
  • NOT_IN: retrieves the column whose value is not in the IN list.
EQUAL
ValuestringNo

The value used in the filter condition.

1
BetweenStartstringNo

The start value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.

1
BetweenEndstringNo

The end value of the range used in the filter condition. This parameter takes effect only when Operator is set to BETWEEN.

10
InListarrayNo

The IN list used in the filter condition. This parameter takes effect only when Operator is set to IN or NOT_IN.

stringNo

A value in the IN list. This parameter takes effect only when Operator is set to IN or NOT_IN.

1
TidlongNo

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

62***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The ID of the request.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
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
TrackResultobject

The parsing result of the data tracking task.

TotalCountlong

The total number of entries returned.

109
EventListarray<object>

The details of the event logs.

Eventobject

The details of an event log.

DataAfterarray

The data records after you perform data operations in the database.

DataAfterstring

A data record after you perform data operations in the database.

1
DataBeforearray

The data records before you perform data operations in the database.

DataBeforestring

A data record before you perform data operations in the database.

2
EventLengthlong

The length of the event content. Unit: bytes.

4324
EventTimestampstring

The event time.

2023-04-23 10:25:47
EventTypestring

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
EventIdlong

The ID of the event.

1
RollSQLstring

The SQL statements used to roll back the data change.

-- 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)"
TableInfoListarray<object>

The metadata of tables for which you track data operations.

TableInfoobject

The metadata of a table for which you track data operations.

SchemaNamestring

The name of the database.

prod_eb_vas
TableNamestring

The name of the table.

import_table_test1
Columnsarray<object>

The information about columns.

Columnobject

The information about a column.

ColumnNamestring

The name of the column.

basic_platform
ColumnPositioninteger

The position of the column.

1
ColumnTypestring

The data type of the column. Examples: BIGINT, INT, and VARCHAR.

BIGINT
Fictiveboolean

Indicates whether the column is a virtual column. Valid values:

  • true
  • false
true
Descriptionstring

The description of the column.

auto-description

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history