PreCheckSqlFlashbackTask - PolarDB - Alibaba Cloud Documentation Center

Performs a pre-check and feasibility assessment on a recovery task before executing SQL flashback recovery.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
PolardbxInstanceId	string	Yes	The cluster ID.	pxc-*********
DbName	string	Yes	The database name.	test
StartTime	string	Yes	The start time of the flashback SQL execution.	2025-09-21 14:35:00
EndTime	string	Yes	The end time of the flashback SQL execution.	2025-09-21 14:41:00

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	14036EBE-***-44DB-ACE9-AC6157D3A6FC
Message	string	The response message. This parameter is empty when the request succeeds. When the request fails, an exception message is returned, such as an error code.	successs
Success	boolean	The request result.	true
Data	object	The returned result set.
CheckResult	object	The check result.
CanUpgradeSupportBinlogRowQueryEvents	boolean	Indicates whether the upgrade can succeed.
BinlogRowQueryEventEnabled	boolean	Indicates whether the recording of original SQL query events is enabled. Valid values: true: Enabled. false: Disabled.
SupportBinlogRowQueryEvents	boolean	Indicates whether log recording is supported. Valid values: true: Supported. false: Not supported.
BinlogExists	boolean	Indicates whether valid binary log files exist. This value is used to determine whether operations such as flashback and synchronization can be performed.
HasTable	boolean	Indicates whether the table exists. Valid values: true and false.

Examples

Success response

JSON format

{
  "RequestId": "14036EBE-***-44DB-ACE9-AC6157D3A6FC",
  "Message": "successs",
  "Success": true,
  "Data": {
    "CheckResult": {
      "CanUpgradeSupportBinlogRowQueryEvents": false,
      "BinlogRowQueryEventEnabled": false,
      "SupportBinlogRowQueryEvents": false,
      "BinlogExists": false,
      "HasTable": false
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.