DescribeSqlFlashbakTask - PolarDB - Alibaba Cloud Documentation Center

Queries a list of flashback tasks.

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

drds:DescribeSqlFlashbakTask

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds****c6vxxyzd

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful.	true
RequestId	string	The request ID.	5D64DE59-44A1-E541-E0CB-B7E5C4305162
SqlFlashbackTasks	object
SqlFlashbackTask	array<object>	The flashback task.
	object
TableName	string	The table to which the data belongs.	drds_params
SearchEndTime	integer	The end time of the search.	1568509597000
ExpireTime	integer	The expiration time of the download URL.	1569216270000
DownloadUrl	string	The download URL.	http://...
RecallProgress	integer	The reverse recall progress.	10
SqlPk	string	The primary key value specified in the SQL statement.	id
InstId	string	The instance ID.	drdshbga76p6****
RecallType	integer	The flashback type. Valid values: 0: exact match 1: fuzzy match	1
SearchStartTime	integer	The start time of the search.	1568609597000
GmtModified	integer	The modification time.	1568611469000
SqlCounter	integer	The number of restored data rows.	0
DbName	string	The name of the database for the flashback task.	drds_flashback
RecallRestoreType	integer	The restoration type. Valid values: 1: mirror restoration 2: reverse restoration	1
GmtCreate	integer	The creation time.	1568611408000
TraceId	string	The trace ID of the SQL statement.	trace
Id	integer	The primary key ID.	238
RecallStatus	integer	The status of the data recall task.	1
SqlType	string	The type of the SQL statement.	Insert,Update,Delete

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "5D64DE59-44A1-E541-E0CB-B7E5C4305162",
  "SqlFlashbackTasks": {
    "SqlFlashbackTask": [
      {
        "TableName": "drds_params",
        "SearchEndTime": 1568509597000,
        "ExpireTime": 1569216270000,
        "DownloadUrl": "http://...",
        "RecallProgress": 10,
        "SqlPk": "id",
        "InstId": "drdshbga76p6****",
        "RecallType": 1,
        "SearchStartTime": 1568609597000,
        "GmtModified": 1568611469000,
        "SqlCounter": 0,
        "DbName": "drds_flashback",
        "RecallRestoreType": 1,
        "GmtCreate": 1568611408000,
        "TraceId": "trace",
        "Id": 238,
        "RecallStatus": 1,
        "SqlType": "Insert,Update,Delete"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.