DescribeBackupLocal - PolarDB - Alibaba Cloud Documentation Center

Calls the DescribeBackupLocal operation to query binary log settings.

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

*instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID of the DRDS instance.	drds************

Response elements

Element	Type	Description	Example
	object
Success	boolean	The result of the request.	true
RequestId	string	The request ID.	FDC9CFD5-306D-4A23-9D8C-057274C6****
BackupPolicyDO	object	The details of the backup policy settings.
BackupDbName	string	This parameter is not returned for this API operation.	null
LogBackupRetentionPeriod	integer	This parameter is not returned for this API operation.	0
DataBackupRetentionPeriod	integer	This parameter is not returned for this API operation.	0
BackupType	string	This parameter is not returned for this API operation.	null
BackupLevel	string	This parameter is not returned for this API operation.	null
LocalLogRetentionHours	integer	The number of hours for which log backups are retained locally. Valid values: 0 to 168. A value of 0 indicates that log backups are not retained. Default value: 18.	18
HighSpaceUsageProtection	integer	Specifies whether to unconditionally clean up binary logs when the instance storage usage exceeds 90% or the remaining storage is less than 5 GB. Valid values: 1: enabled. 0: disabled.	1
GmtModified	integer	This parameter is not returned for this API operation.	0
BackupRetentionPeriod	integer	This parameter is not returned for this API operation.	0
BackupPolicyMode	string	This parameter is not returned for this API operation.	null
PreferredBackupPeriod	string	This parameter is not returned for this API operation.	null
LocalLogRetentionSpace	integer	The maximum storage usage of binary logs, in percentage. Valid values: 0 to 50. This is a circular space. Default value: 30.	30
BackupAppName	string	This parameter is not returned for this API operation.	null
PreferredBackupTime	string	This parameter is not returned for this API operation.	null
GmtCreate	integer	This parameter is not returned for this API operation.	0
BackupMode	string	This parameter is not returned for this API operation.	null
BackupLog	string	This parameter is not returned for this API operation.	null
NextBackupActuallyTime	string	This parameter is not returned for this API operation.	null

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "FDC9CFD5-306D-4A23-9D8C-057274C6****",
  "BackupPolicyDO": {
    "BackupDbName": "null",
    "LogBackupRetentionPeriod": 0,
    "DataBackupRetentionPeriod": 0,
    "BackupType": "null",
    "BackupLevel": "null",
    "LocalLogRetentionHours": 18,
    "HighSpaceUsageProtection": 1,
    "GmtModified": 0,
    "BackupRetentionPeriod": 0,
    "BackupPolicyMode": "null",
    "PreferredBackupPeriod": "null",
    "LocalLogRetentionSpace": 30,
    "BackupAppName": "null",
    "PreferredBackupTime": "null",
    "GmtCreate": 0,
    "BackupMode": "null",
    "BackupLog": "null",
    "NextBackupActuallyTime": "null"
  }
}

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.