All Products
Search
Document Center

ApsaraDB RDS:ReceiveDBInstance

Last Updated:Nov 22, 2024

Switches a primary instance to a disaster recovery instance or a disaster recovery instance to a primary instance.

Operation description

The operation is phased out.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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

rm-uf6wjk5*****
GuardDBInstanceIdstringYes

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

rm-tr2whku*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

GuardDBInstanceIdstring

The ID of the disaster recovery instance after the switchover.

rm-tr2whku*****
RequestIdstring

The request ID.

EFB6083A-7699-489B-8278-C0CB4793A96E

Examples

Sample success responses

JSONformat

{
  "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
2024-11-12API Description Update. The Error code has changedView Change Details
2022-06-20Add OperationView Change Details