All Products
Search
Document Center

ApsaraDB RDS:DescribeCrossRegionBackupDBInstance

Last Updated:Feb 29, 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

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:DescribeCrossRegionBackupDBInstanceREAD
  • 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
Itemsobject []

The cross-region backup settings.

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.
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.
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.

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