UpgradeDBInstance - AnalyticDB - Alibaba Cloud Documentation Center

Changes the configurations of an AnalyticDB for PostgreSQL instance.

Operation description

This operation is not available for instances in reserved storage mode.

Before you call this operation, make sure that you are familiar with the billing of AnalyticDB for PostgreSQL. For more information, see Billing methods and AnalyticDB for PostgreSQL pricing.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:UpgradeDBInstance	update	*DBInstance `acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see View basic information of a resource group.	rg-bp67acfmxazb4p****
RegionId	string	No	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceClass	string	No	This parameter is no longer used.	null
DBInstanceGroupCount	string	No	This parameter is no longer used.	null
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.	gp-rj***************
PayType	string	No	This parameter is no longer used.	null
MasterNodeNum	string	No	This parameter is no longer used.	2
SegNodeNum	string	No	The number of compute nodes. The number of compute nodes varies based on the instance resource type and edition. Valid values for High-availability Edition instances in elastic storage mode: 4 to 512, in 4 increments. Valid values for High-performance Edition instances in elastic storage mode: 2 to 512, in 2 increments. Valid values for instances in manual Serverless mode: 2 to 512, in 2 increments.	2
InstanceSpec	string	No	The specifications of each compute node. For information about the supported specifications, see Instance specifications. Note This parameter is available only for instances in elastic storage mode.	4C16G
StorageSize	string	No	The storage capacity of each compute node. Unit: GB. Valid values: 50 to 6000, in 50 increments. Note This parameter is available only for instances in elastic storage mode.	100
SegDiskPerformanceLevel	string	No	The performance level of Enterprise SSDs (ESSDs). Valid values: pl0 pl1 pl2	pl1
SegStorageType	string	No	The disk storage type of the instance after the change. The disk storage type can be changed only to ESSD. Set the value to cloud_essd.	cloud_essd
UpgradeType	long	No	The type of the instance configuration change. Valid values: 0 (default): changes the number of compute nodes. 1: changes the specifications and storage capacity of each compute node. 2: changes the number of coordinator nodes. 3: changes the disk storage type and ESSD performance level of the instance. Note The supported changes to compute node configurations vary based on the instance resource type. For more information, see the "Usage notes" section of the Change compute node configurations topic. After you specify a change type, only the corresponding parameters take effect. For example, if you set UpgradeType to 0, the parameter that is used to change the number of compute nodes takes effect, but the parameter that is used to change the number of coordinator nodes does not. The number of coordinator nodes can be changed only on the China site (aliyun.com). The disk storage type can be changed only from ultra disks to ESSDs.	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	25C11EE5-B7E8-481A-A07C-BD**********
DBInstanceId	string	The instance ID.	gp-rj***************
OrderId	string	The order ID.	*********

Examples

Sample success responses

JSONformat

{
  "RequestId": "25C11EE5-B7E8-481A-A07C-BD**********",
  "DBInstanceId": "gp-rj***************",
  "OrderId": "*********"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-04	The internal configuration of the API is changed, but the call is not affected	View Change Details