DescribeSqlFlashbackTaskList - PolarDB - Alibaba Cloud Documentation Center

Queries the list of SQL flashback tasks by calling the DescribeSqlFlashbackTaskList operation.

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

polardbx:DescribeSqlFlashbackTaskList

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the instance resides.	cn-hangzhou
PolardbxInstanceId	string	Yes	The instance ID of the PolarDB-X instance.	pxc-**********

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9B2F3840-5C98-475C-B269-2D5C3A31797C
Message	string	The description of the request result.	OK
Success	boolean	Indicates whether the API request was successful.	true
Data	object	The data returned by the request.
SqlFlashbackTasks	array<object>	The flashback task objects.
	object	The flashback task objects.
GmtModified	string	The last modification time of the flashback task in the database. Unit: ms.	1568611469000
SearchEndTime	string	The end time specified when the SQL flashback task was submitted. Unit: ms.	1568609597000
RecallStatus	string	The status of the data recall task. Valid values: 1: In progress. 2: Completed.	1
SqlPk	string	The primary key value involved in the SQL statement.	id
RecallRestoreType	string	The SQL flashback restoration type. Valid values: 1: Image-based restoration. 2: Reverse restoration.	0
TableName	string	The name of the table to which the data belongs.	test
GmtCreate	string	The creation time of the flashback task in the database. Unit: ms.	1568611408000
InstId	string	The instance ID of the PolarDB-X instance.	pxc-********
SearchStartTime	string	The start time specified when the SQL flashback task was submitted. Unit: ms.	1568609597000
RecallType	string	The recall type. Valid values: 0: exact match. 1: fuzzy match.	0
TraceId	string	The trace_id of the SQL statement.	13ed05705f801000
DbName	string	The name of the database on which the flashback task was performed.	test
SqlType	string	The type of the SQL statement. Valid values: INSERT, UPDATE, and DELETE. Multiple types are separated by commas (,).	INSERT,UPDATE
Id	string	The primary key ID.	111
ExpireTime	string	The expiration time of the download URL. Unit: ms.	1569216270000
SqlCounter	string	The number of recovered data rows.	100
RecallProgress	string	The execution progress of the flashback task. Value range: 1 to 100.	10
DownloadUrl	string	The download URL of the result file.	http://...

Examples

Success response

JSON format

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Message": "OK",
  "Success": true,
  "Data": {
    "SqlFlashbackTasks": [
      {
        "GmtModified": "1568611469000",
        "SearchEndTime": "1568609597000",
        "RecallStatus": "1",
        "SqlPk": "id",
        "RecallRestoreType": "0",
        "TableName": "test",
        "GmtCreate": "1568611408000",
        "InstId": "pxc-********",
        "SearchStartTime": "1568609597000",
        "RecallType": "0",
        "TraceId": "13ed05705f801000",
        "DbName": "test",
        "SqlType": "INSERT,UPDATE",
        "Id": "111",
        "ExpireTime": "1569216270000",
        "SqlCounter": "100",
        "RecallProgress": "10",
        "DownloadUrl": "http://..."
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.