docs
api
Cloud Database(UDB)
PromoteUDBSlave

Promote from Slave - PromoteUDBSlave

Overview

Promote from replica to standalone database

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is PromoteUDBSlave.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
DBIdstringInstance's Id, this value can be obtained through DescribeUDBInstanceYes
IsForcebooleanWhether to enforce (promotion may be prohibited if the slave is lagging), default is false. If lagging, forced promotion will result in data loss.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No

Example

Request Example

https://api.surfercloud.com/?Action=PromoteUDBSlave
&Region=cn-bj2
&DBId=udb-xxx
&IsForce=true                             

Response Example

{
  "Action": "PromoteUDBSlaveResponse",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved