All Products
Search

This Product

    ApsaraDB RDS:DescribeBackupPolicy

    Document Center

    ApsaraDB RDS:DescribeBackupPolicy

    Last Updated:Sep 26, 2023

    Queries the backup settings of an instance.

    Operation Description

    Supported database engines

    • MySQL
    • PostgreSQL
    • SQL Server
    • MariaDB

    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.

    debugging

    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
    rds:DescribeBackupPolicyREAD
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-uf6wjk5xxxxxxx
    BackupPolicyModestringNo

    The backup type. Valid values:

    • DataBackupPolicy: data backup
    • LogBackupPolicy: log backup
    		DataBackupPolicy
    CompressTypestringNo

    The method that is used to compress backup data. Valid values:

    • 0: Backup data is not compressed.
    • 1: Backup data is compressed by using zlib.
    • 2: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.
    • 4: Backup data is compressed by using QuickLZ and can be used to restore individual databases and tables.
    • 8: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables. This value is available only when the instance runs MySQL 8.0.
    		1
    ReleasedKeepPolicystringNo

    The policy that is used to retain archived backup files if the instance is released. Valid values:

    • None: No archived backup files are retained.
    • Lastest: Only the last archived backup file is retained.
    • All: All archived backup files are retained.
    		Lastest

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    LogBackupRetentionPeriodinteger

    The number of days for which log backup files are retained.

    		7
    ArchiveBackupKeepPolicystring

    The cycle based on which archived backup files are retained.

    		ByMonth
    ArchiveBackupKeepCountstring

    The number of archived backup files that are retained.

    		1
    LocalLogRetentionHoursinteger

    The number of hours for which log backup files are retained on the instance.

    		0
    BackupRetentionPeriodinteger

    The number of days for which data backup files are retained.

    		7
    RequestIdstring

    The ID of the request.

    		B87E2AB3-B7C9-4394-9160-7F639F732031
    PreferredBackupPeriodstring

    The cycle based on which you want to perform a backup. Separate multiple values with commas (,). Valid values:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    		Monday,Wednesday,Friday,Sunday
    CompressTypestring

    The method that is used to compress backup data. Valid values:

    • 0: Backup data is not compressed.
    • 1: Backup data is compressed by using zlib.
    • 2: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.
    • 4: Backup data is compressed by using QuickLZ and can be used to restore individual databases and tables.
    • 8: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables. This value is available only when the instance runs MySQL 8.0.
    		1
    SupportReleasedKeepinteger

    A reserved parameter.

    		0
    LocalLogRetentionSpacestring

    The maximum storage usage that is allowed for log files on the instance.

    		30
    SupportVolumeShadowCopyinteger

    Indicates whether the instance supports snapshot backups. Valid values:

    • 1: The instance supports snapshot backups.
    • 0: The instance does not support snapshot backups.
    Note This parameter is returned only when the instance runs SQL Server.
    		1
    BackupMethodstring

    The backup method of the instance. Valid values:

    • Physical: physical backup
    • Snapshot: snapshot backup
    Note This parameter is returned only when the instance runs SQL Server and uses cloud disks.
    		Physical
    LogBackupFrequencystring

    The backup frequency of logs. Valid values:

    • LogInterval: Log backups are performed every 30 minutes.
    • Default value: same as the value of the PreferredBackupPeriod parameter.
    Note The LogBackupFrequency parameter is supported only when the instance runs SQL Server.
    		LogInterval
    PreferredNextBackupTimestring

    The time when the next backup is performed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

    		2018-01-19T15:15Z
    HighSpaceUsageProtectionstring

    Indicates whether the log backup deletion feature is enabled. If the disk usage exceeds 80% or the remaining disk space is less than 5 GB on the instance, this feature deletes binary log files. Valid values:

    • Disable
    • Enable
    		Enable
    ArchiveBackupRetentionPeriodstring

    The number of days for which archived backup files are retained.

    		365
    BackupIntervalstring

    The backup interval. Unit: minutes.

    • If the instance runs MySQL, the interval is the same as the value of the Snapshot Backup Start Time parameter rather than the Snapshot Backup Period parameter in the ApsaraDB RDS console. For more information, see Back up an ApsaraDB RDS for MySQL instance.
    • If the instance runs SQL Server, the interval is the same as the log backup frequency.
    		30
    ReleasedKeepPolicystring

    The policy that is used to retain archived backup files if the instance is released. Valid values:

    • None: No archived backup files are retained.
    • Lastest: Only the last archived backup file is retained.
    • All: All archived backup files are retained.
    		None
    PreferredBackupTimestring

    The time when a data backup is performed. The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

    		15:00Z-16:00Z
    LogBackupLocalRetentionNumberinteger

    The number of binary log files that you want to retain on the instance.

    		60
    Categorystring

    Indicates whether to enable the single-digit second backup feature. This feature allows ApsaraDB RDS to complete a backup within single-digit seconds. Valid values:

    • Flash: The single-digit second backup feature is enabled.
    • Standard: The single-digit second backup feature is disabled.
    Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
    		Standard
    EnableBackupLogstring

    Indicates whether the log backup feature is enabled. Valid values:

    • 1: The log backup feature is enabled.
    • 0: The log backup feature is disabled.
    		1
    BackupLogstring

    Indicates whether the log backup feature is enabled. Valid values:

    • Enable
    • Disabled
    		Enable
    EnableIncrementDataBackupboolean

    Indicates whether incremental backup is enabled. Valid values:

    • True: Incremental backup is enabled.
    • False: Incremental backup is disabled.
    		True
    SupportModifyBackupPriorityboolean

    Indicates whether the backup settings of a secondary instance can be modified. Valid values:

    • True
    • False
    		False
    BackupPriorityinteger

    The backup settings of the secondary instance. Valid values:

    • 1: Secondary instance preferred
    • 2: Primary instance preferred
    Note This parameter is valid only when the instance runs SQL Server on RDS Cluster Edition. This parameter is returned only when SupportModifyBackupPriority is set to True.
    		2

    Examples

    Sample success responses

    JSONformat

    {
  "LogBackupRetentionPeriod": 7,
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupKeepCount": "1",
  "LocalLogRetentionHours": 0,
  "BackupRetentionPeriod": 7,
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "CompressType": "1",
  "SupportReleasedKeep": 0,
  "LocalLogRetentionSpace": "30",
  "SupportVolumeShadowCopy": 1,
  "BackupMethod": "Physical",
  "LogBackupFrequency": "LogInterval",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "HighSpaceUsageProtection": "Enable",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "ReleasedKeepPolicy": "None",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "LogBackupLocalRetentionNumber": 60,
  "Category": "Standard",
  "EnableBackupLog": "1",
  "BackupLog": "Enable",
  "EnableIncrementDataBackup": true,
  "SupportModifyBackupPriority": true,
  "BackupPriority": 2
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IO.ExceptionIO exception, retry later.An I/O error occurred.
    400InternalFailureInternal failure, retry later.The request failed. Please try again later.
    400InvalidParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.
    400InvalidEngine.MalformedSpecified engine is not valid.The database engine is invalid. Specify a valid database engine.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
    404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

    Change history

    Change timeSummary of changesOperation
    2023-06-29The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2022-06-24API Description Update,The error codes of the API operation change.see changesets
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404