All Products
Search
Document Center

ApsaraDB RDS:DescribeAvailableCrossRegion

Last Updated:Jun 13, 2024

Queries the available destination regions to which the cross-region backup files from a specific source region can be replicated.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling 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:DescribeAvailableCrossRegionRead
  • DBInstance
    acs:rds:*:{#accountId}:dbinstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent zone list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

39265F46-EC77-4036-8AC4-F035F32F6BE2
Regionsarray

An array that consists of destination regions for cross-region backups.

string

The list of destination regions that support cross-region backup.

"cn-qingdao","cn-shanghai", "cn-shenzhen"

Examples

Sample success responses

JSONformat

{
  "RequestId": "39265F46-EC77-4036-8AC4-F035F32F6BE2",
  "Regions": {
    "Region": [
      "\"cn-qingdao\",\"cn-shanghai\", \"cn-shenzhen\""
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
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.
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