All Products
Search
Document Center

ApsaraDB RDS:ModifyInstanceCrossBackupPolicy

Last Updated:Jun 13, 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
  • rds:BackupEnabled
  • rds:LogBackupEnabled
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.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
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.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403InvalidVswitchIdSpecified conn vswitch id is not valid.-
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.
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.

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