Modify the configuration of the UDB instance - ResizeUDBInstance

Overview

Modify (upgrade and downgrade) the configuration of the UDB instance, including the configuration of memory and disk. For memory upgrades, there is no need to shut down the instance, other scenarios require shutting down the instance in advance. Two sets of parameters can be configured for the upgrade and downgrade machine: 1. Configure UseSSD and SSDType 2. Configure InstanceType, no need to configure InstanceMode. The priority of the second set of parameters is higher.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ResizeUDBInstance`.	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
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
DBId	string	Instance’s Id	Yes
MemoryLimit	int	Memory Limit (MB), currently supports the following levels 2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M/128000M/192000M/256000M/320000M.	Yes
DiskSpace	int	Disk Space (GB), temporarily supports 20G-32T	Yes
SSDType	string	SSD type, optional values are “SATA” and “NVMe”.	No
InstanceType	string	UDB Database Models: “Normal”: “Standard Model” , “SATA_SSD”: “SSD Model” , “PCIE_SSD”: “High Performance SSD Model” , “Normal_Volume”: “Standard High Capacity Model”, “SATA_SSD_Volume”: “SSD High Capacity Model” , “PCIE_SSD_Volume”: “High Performance SSD High Capacity Model”, “NVMe_SSD”: “Fast Model”	No
InstanceMode	string	UDB instance mode type, optional values are as follows: “Normal”: Standard version UDB instance “HA”: High availability version UDB instance The default is “Normal”.	No
StartAfterUpgrade	boolean	Upgrading or downgrading the DB in the closed state, whether to start the DB after upgrading or downgrading, the default is false.	No
MachineType	string	Specification Type ID, valid when SpecificationType is 1	No
SpecificationType	string	The type of instance computing specification, 0 or no transmission means purchasing by memory method, 1 means purchasing by optional memory-cpu ratio method, need to fill in MachineType.	No
CPU	int	Number of CPU cores for the database (only useful for the standard version of SQLServer)	No
CouponId	string	ID of the voucher used	No

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

Example

Request Example

https://api.dezai.com/?Action=ResizeUDBInstance
&Region=cn-bj2
&DBId=udb-xxx
&MemoryLimit=15000
&DiskSpace=500
&MachineType=ZFyPches
&SpecificationType=cEsDNnjF
&CPU=3

Response Example

{
  "Action": "ResizeUDBInstanceResponse",
  "RetCode": 0
}

RestartUDBInstance ChangeUDBParamGroup