All Products
Search

This Product

    ApsaraDB RDS:ModifyInstanceCrossBackupPolicy

    Document Center

    ApsaraDB RDS:ModifyInstanceCrossBackupPolicy

    Last Updated:Apr 17, 2024

    Modifies the cross-region backup settings of an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL
    • SQL Server

    References

    Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID.

    		rm-uf6wjk5xxxxxxxxxx
    RegionIdstringYes

    The region ID of the source instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    CrossBackupTypestringNo

    The policy that is used to save the cross-region backup files of the instance. Set the value to 1. The value 1 specifies that all cross-region backup files are saved.

    		1
    LogBackupEnabledstringNo

    Specifies whether to enable the cross-region log backup feature on the instance. Valid values:

    • 0: disables the feature.
    • 1: enables the feature.
    Note You can enable the cross-region log backup feature only when the cross-region backup feature is enabled.
    		1
    BackupEnabledstringNo

    Specifies whether to enable the cross-region backup feature on the instance. This parameter specifies whether you can back up data and logs. Valid values:

    • 0: disables the feature.
    • 1: enables the feature.
    Note Before you enable the cross-region backup feature, you must configure the CrossBackupRegion parameter.
    		1
    CrossBackupRegionstringNo

    The ID of the region in which the cross-region backup files of the instance are stored.

    		cn-shanghai
    RetentTypeintegerNo

    The policy that is used to retain the cross-region backup files of the instance. Set the value to 1. The value 1 specifies that the cross-region backup files of the instance are retained based on the specified retention period.

    		1
    RetentionintegerNo

    The number of days for which the cross-region backup files of the instance are retained. Valid values: 7 to 1825.

    		7

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    BackupEnabledstring

    The status of the cross-region backup feature on the instance. Valid values:

    • Disable
    • Enable
    		Enable
    RegionIdstring

    The region ID of the source instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    LogBackupEnabledstring

    The status of the cross-region log backup feature on the instance. Valid values:

    • Disable
    • Enable
    		Enable
    RequestIdstring

    The ID of the request.

    		50A6059D-6DBB-46C6-A851-1EE93C9013CF
    RetentTypeinteger

    The policy that is used to retain the cross-region backup files of the instance. Default value: 1. The value 1 indicates that the cross-region backup files of the instance are retained based on the specified retention period.

    		1
    CrossBackupRegionstring

    The ID of the region in which the cross-region backup files of the instance are stored.

    		cn-shanghai
    CrossBackupTypestring

    The policy that is used to save the cross-region backup files of the instance. Default value: 1. The value 1 indicates that all cross-region backup files are saved.

    		1
    Retentioninteger

    The number of days for which the cross-region backup files of the instance are retained. Valid values: 7 to 1825.

    		15
    DBInstanceIdstring

    The instance ID.

    		rm-uf6wjk5xxxxxxxxxx

    Examples

    Sample success responses

    JSONformat

    {
  "BackupEnabled": "Enable",
  "RegionId": "cn-hangzhou",
  "LogBackupEnabled": "Enable",
  "RequestId": "50A6059D-6DBB-46C6-A851-1EE93C9013CF",
  "RetentType": 1,
  "CrossBackupRegion": "cn-shanghai",
  "CrossBackupType": "1",
  "Retention": 15,
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.FormatSpecified parameter is not valid.-
    400ParameterAbsenceNecessary param is absence.-
    400ParameterLeastAssociateMust input at least one optional parameter.The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.
    400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
    400InvalidParameters.FormatSpecified parameter(maxrecordsperpage) is not valid.-
    400OperationDenied.SwitchToCrossRegionBackupSnapshot backup does not support cross region backup storage at present.Snapshot backups cannot be stored across regions.
    400OperationDenied.SwitchToSnapshotSnapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode.
    400OperationDenied.SwitchSnapshotToPhysicalOnly physical backup to snapshot backup is supported.The current operation only supports physical backups to snapshot backups.
    400UnsupportEncryptedSnapshotEncrypted DB instance snapshot does not support this operation.This operation is not supported for encrypted instance snapshots.
    403IncorrectEngineVersionCurrent engine version does not support operations.The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.
    403IncorrectHostTypeCurrent DB Instance host type does not support this operation.This operation is not supported for the host type of the current instance.
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403InvalidDdrStorage.NotFoundSpecified Ddr Storage does not exist or not support.-
    403CrossBackupNotSupportSpecified region not support cross region backup.Cross-zone backup is not supported in the specified region.
    404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
    404InvalidPage.notFoundPage not found.The specified parameters are not found. Check your parameters.

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

    Change history

    Change timeSummary of changesOperation
    2022-09-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      delete Error Codes: 400
      delete Error Codes: 403
    2022-06-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404