All Products
Search
Document Center

ApsaraDB RDS:DescribeCrossRegionBackupDBInstance

Last Updated:Nov 01, 2024

Queries the instances for which the cross-region backup feature is enabled in a region and the cross-region backup settings of these instances.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

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

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
DBInstanceIdstringNo

The instance ID. Up to 30 instance IDs are allowed in a single request. If you enter more than one instance ID, separate them with commas (,).

rm-uf6wjk5xxxxxxxxxx
PageSizeintegerNo

The number of entries to return per page. Default value: 30.

30
PageNumberintegerNo

The number of the page to return. Valid values: any non-zero positive integer.

Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

33517002-182D-40BE-93EC-610BD3381045
TotalRecordsinteger

The total number of entries returned.

100
ItemsNumbersinteger

The total number of items returned for cross-region backup settings.

1
PageSizeinteger

The number of entries per page. Default value: 30.

30
PageNumberinteger

The page number. Pages start from page 1.

Default value: 1.

1
RegionIdstring

The region ID.

cn-hangzhou
Itemsarray<object>

The cross-region backup settings.

Itemobject
LogBackupEnabledTimestring

The time when the cross-region log backup feature was enabled on the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-06-12T05:44:21Z
BackupEnabledstring

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

  • Disable
  • Enable
Enable
DBInstanceStatusstring

The instance status. For more information, see Instance statuses.

Running
LockModestring

The lock status of the instance. Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance is manually locked.
  • LockByExpiration: The instance is automatically locked after it expires.
  • LockByRestoration: The instance is automatically locked before it is rolled back.
  • LockByDiskQuota: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
Unlock
EngineVersionstring

The database engine version.

5.6
LogBackupEnabledstring

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

  • Disable
  • Enable
Enable
RetentTypeinteger

The policy that is used to retain the cross-region backup files of the instance. Cross-region backups can be retained only based on the specified retention period. Default value: 1.

1
Retentioninteger

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

15
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
CrossBackupRegionstring

The ID of the destination region within which the cross-region backup file is stored.

cn-shanghai
DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxxxxx
Enginestring

The database engine of the instance.

MySQL
BackupEnabledTimestring

The time when cross-region backup was enabled on the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-06-12T05:44:21Z
DBInstanceDescriptionstring

The name of the instance. It must be 2 to 256 characters in length. The value can contain letters, digits, underscores (_), and hyphens (-), and must start with a letter.

Note The value cannot start with http:// or https://.
Test database

Examples

Sample success responses

JSONformat

{
  "RequestId": "33517002-182D-40BE-93EC-610BD3381045",
  "TotalRecords": 100,
  "ItemsNumbers": 1,
  "PageSize": 30,
  "PageNumber": 1,
  "RegionId": "cn-hangzhou",
  "Items": {
    "Item": [
      {
        "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
        "BackupEnabled": "Enable",
        "DBInstanceStatus": "Running",
        "LockMode": "Unlock",
        "EngineVersion": "5.6",
        "LogBackupEnabled": "Enable",
        "RetentType": 1,
        "Retention": 15,
        "CrossBackupType": "1",
        "CrossBackupRegion": "cn-shanghai",
        "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "Engine": "MySQL",
        "BackupEnabledTime": "2019-06-12T05:44:21Z",
        "DBInstanceDescription": "Test database\n"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameters.FormatSpecified parameter is not valid.-
400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
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 cost and cost 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.Hello customer, this area has been abolished.
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.
403CrossBackupNotSupportSpecified region not support cross region backup.Cross-zone backup is not supported in the specified region.
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.
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.-
404InvalidPage.notFoundPage not found.The specified parameters are not found. Check your parameters.
404InvalidUser.NotFoundSpecified user does not exist.The specified user is not found. Please check again.
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 changedView Change Details