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 Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CheckUDBInstanceToHAAllowance. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console  | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project 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 |
| DBId | string | Instance’s Id, this value can be obtained through DescribeUDBInstance | Yes |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| Allowance | string | Yes, No, Yes means it can be upgraded, No means it cannot be upgraded | No |
Example
Request Example
https://api.surfercloud.com/?Action=CheckUDBInstanceToHAAllowance
&Region=cn-bj2
&DBId=udb-xxxxxResponse Example
{
"Action": "CheckUDBInstanceToHAAllowanceResponse",
"Allowance": "Yes",
"RetCode": 0
}