All Products
Document Center

ApsaraDB RDS:ReceiveDBInstance

Last Updated:May 29, 2023

You can call the ReceiveDBInstance operation to switch a primary instance to a disaster recovery instance.

Operation Description

The ID of the request.

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

Request parameters


The ID of the disaster recovery instance. You can call the DescribeDBInstances operation to query the ID of the disaster recovery instance.


Response parameters



Sample success responses


  "GuardDBInstanceId": "rm-tr2whku*****",
  "RequestId": "EFB6083A-7699-489B-8278-C0CB4793A96E"

Error codes

HTTP status codeError codeError messageDescription
400GuardInstance.ExistThe guard instance has exist.The disaster recovery instance already exists.
404InvalidDBInstanceId.NotFoundThe specified instance does not exist or is not supported.-

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

Change history

Change timeSummary of changesOperation
2022-06-20Add Operation