Docs
api
Cloud Database(UDB)
CheckUDBInstanceToHAAllowance

Check if the db can be upgraded to high availability - CheckUDBInstanceToHAAllowance

Overview

Check if the db can be upgraded to high availability

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CheckUDBInstanceToHAAllowance.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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, and the sub-account 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
AllowancestringYes, No, Yes means it can be upgraded, No means it cannot be upgradedNo

Example

Request Example

https://api.dezai.com/?Action=CheckUDBInstanceToHAAllowance
&Region=cn-bj2
&DBId=udb-xxxxx

Response Example

{
  "Action": "CheckUDBInstanceToHAAllowanceResponse",
  "Allowance": "Yes",
  "RetCode": 0
}