All Products
Search
Document Center

Data Management:DownloadDataTrackResult

Last Updated:Nov 28, 2024

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

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

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

406****
RollbackSQLTypestringYes

The type of the SQL statement.

  • REVERSE: undoes or rolls back an executed SQL statement, which is equivalent to the UNDO SQL statement.
  • FORWARD: redoes or re-executes an SQL statement that failed to be executed, which is equivalent to the REDO SQL statement.
REVERSE
FilterStartTimestringNo

The start time of the time range in which you want to track data operations. The time must be specified 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 specified 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.

account_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.

stringNo

This parameter takes effect only when Operator is set to IN or NOT_IN.

1
EventIdListarrayNo

The IDs of the events.

longNo

The event ID.

1
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

B43AD641-49C2-5299-9E06-1B37EC1B****
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
DownloadKeyIdstring

The ID of the download key, which is used to download the parsing result of the data tracking task.

e23dd7ec-a19f-4a69-8eb3-8ffd26e6****

Examples

Sample success responses

JSONformat

{
  "RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DownloadKeyId": "e23dd7ec-a19f-4a69-8eb3-8ffd26e6****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history