docs
api
Cloud Database(UDB)
PromoteUDBInstanceToHA

Upgrade regular db to high availability - PromoteUDBInstanceToHA

Overview

Upgrading a regular db to high availability (only applicable to instances of SSD models with MySQL 5.5 and above), while single-point upgrades to high availability for NVMe models can also use this operation in addition to SwitchUDBInstanceToHA, it is more recommended to directly call the new API interface (UpgradeUDBInstanceToHA).

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is PromoteUDBInstanceToHA.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
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

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=PromoteUDBInstanceToHA
&Region=cn-bj2
&DBId=udb-xxxxxx

Response Example

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