ModifyDBInstanceClass-PolarDB(PolarDB)-阿里云帮助中心

Modifies the specifications of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:ModifyDBInstanceClass

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-hzjasd****
TargetDBInstanceClass	string	No	Target specifications for Standard Edition Primary instance node specifications (Standard Edition) (General-purpose): mysql.n2.medium.25 2 vCPUs, 4 GB (General-purpose) mysql.n4.medium.25 2 vCPUs, 8 GB (General-purpose) mysql.n8.medium.25 2 vCPUs, 16 GB (General-purpose) mysql.n2.large.25 4 vCPUs, 8 GB (General-purpose) mysql.n4.large.25 4 vCPUs, 16 GB (General-purpose) mysql.n8.large.25 4 vCPUs, 32 GB (General-purpose) mysql.n2.xlarge.25 8 vCPUs, 16 GB (General-purpose) mysql.n4.xlarge.25 8 vCPUs, 32 GB (General-purpose) mysql.n8.xlarge.25 8 vCPUs, 64 GB (General-purpose) mysql.n2.2xlarge.25 16 vCPUs, 32 GB (General-purpose) mysql.n4.2xlarge.25 16 vCPUs, 64 GB (General-purpose) mysql.n8.2xlarge.25 16 vCPUs, 128 GB (General-purpose) Primary instance node specifications (Standard Edition) (Dedicated): mysql.x2.medium.25 2 vCPUs, 4 GB (Dedicated) mysql.x4.medium.25 2 vCPUs, 8 GB (Dedicated) mysql.x8.medium.25 2 vCPUs, 16 GB (Dedicated) mysql.x2.large.25 4 vCPUs, 8 GB (Dedicated) mysql.x4.large.25 4 vCPUs, 16 GB (Dedicated) mysql.x8.large.25 4 vCPUs, 32 GB (Dedicated) mysql.x2.xlarge.25 8 vCPUs, 16 GB (Dedicated) mysql.x4.xlarge.25 8 vCPUs, 32 GB (Dedicated) mysql.x8.xlarge.25 8 vCPUs, 64 GB (Dedicated) mysql.x2.2xlarge.25 16 vCPUs, 32 GB (Dedicated) mysql.x4.2xlarge.25 16 vCPUs, 64 GB (Dedicated) mysql.x8.2xlarge.25 16 vCPUs, 128 GB (Dedicated) Read-only instance node specifications (Standard Edition) (General-purpose) rds.mysql.s2.xlarge 2 vCPUs, 8 GB (General-purpose) mysqlro.x4.large.1 4 vCPUs, 16 GB (General-purpose) mysqlro.x4.xlarge.1 8 vCPUs, 32 GB (General-purpose) mysqlro.x4.2xlarge.1 16 vCPUs, 64 GB (General-purpose) Read-only instance node specifications (Standard Edition) (Dedicated) mysqlro.x8.large.1 4 vCPUs, 32 GB (Dedicated) mysqlro.x8.xlarge.1 8 vCPUs, 64 GB (Dedicated) mysqlro.x8.2xlarge.1 16 vCPUs, 128 GB (Dedicated) mysqlro.x4.4xlarge.1 32 vCPUs, 128 GB (Dedicated) mysqlro.x8.4xlarge.1 32 vCPUs, 256 GB (Dedicated)	mysql.n2.medium.25
ClientToken	string	No	The client token. It is an arbitrary unique string used to ensure the idempotence of the request.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
CnClass	string	No	Target specifications for Enterprise Edition compute nodes Primary instance compute node specifications (Enterprise Edition CN) (General-purpose) polarx.x4.medium.2e 2 vCPUs, 8 GB (General-purpose) polarx.x4.large.2e 4 vCPUs, 16 GB (General-purpose) polarx.x4.xlarge.2e 8 vCPUs, 32 GB (General-purpose) polarx.x4.2xlarge.2e 16 vCPUs, 64 GB (General-purpose) Primary instance compute node specifications (Enterprise Edition CN) (Dedicated) polarx.x8.large.2e 4 vCPUs, 32 GB (Dedicated) polarx.x8.xlarge.2e 8 vCPUs, 64 GB (Dedicated) polarx.x8.2xlarge.2e 16 vCPUs, 128 GB (Dedicated) polarx.x4.4xlarge.2e 32 vCPUs, 128 GB (Dedicated) polarx.x8.4xlarge.2e 32 vCPUs, 256 GB (Dedicated) polarx.st.8xlarge.2e 60 vCPUs, 470 GB (Dedicated) polarx.st.12xlarge.2e 90 vCPUs, 720 GB (Dedicated) Read-only instance compute node specifications (Enterprise Edition CN) (General-purpose) polarxro.x4.medium.2e 2 vCPUs, 8 GB (General-purpose) polarxro.x4.large.2e 4 vCPUs, 16 GB (General-purpose) polarxro.x4.xlarge.2e 8 vCPUs, 32 GB (General-purpose) polarxro.x4.2xlarge.2e 16 vCPUs, 64 GB (General-purpose) Read-only instance compute node specifications (Enterprise Edition CN) (Dedicated) polarxro.x8.large.2e 4 vCPUs, 32 GB (Dedicated) polarxro.x8.xlarge.2e 8 vCPUs, 64 GB (Dedicated) polarxro.x8.2xlarge.2e 16 vCPUs, 128 GB (Dedicated) polarxro.x4.4xlarge.2e 32 vCPUs, 128 GB (Dedicated) polarxro.x8.4xlarge.2e 32 vCPUs, 256 GB (Dedicated) polarxro.st.8xlarge.2e 60 vCPUs, 470 GB (Dedicated physical host) polarxro.st.12xlarge.2e 90 vCPUs, 720 GB (Dedicated physical host)	polarx.x4.medium.2e
DnClass	string	No	Target specifications for Enterprise Edition storage nodes Storage node specifications (Enterprise Edition DN) (General-purpose) mysql.n4.medium.25 2 vCPUs, 8 GB (General-purpose) mysql.n4.large.25 4 vCPUs, 16 GB (General-purpose) mysql.n4.xlarge.25 8 vCPUs, 32 GB (General-purpose) mysql.n4.2xlarge.25 16 vCPUs, 64 GB (General-purpose) Storage node specifications (Enterprise Edition DN) (Dedicated) mysql.x8.large.25 4 vCPUs, 32 GB (Dedicated) mysql.x8.xlarge.25 8 vCPUs, 64 GB (Dedicated) mysql.x8.2xlarge.25 16 vCPUs, 128 GB (Dedicated) mysql.x4.4xlarge.25 32 vCPUs, 128 GB (Dedicated) mysql.x8.4xlarge.25 32 vCPUs, 256 GB (Dedicated) mysql.st.8xlarge.25 60 vCPUs, 470 GB (Dedicated) mysql.st.12xlarge.25 90 vCPUs, 720 GB (Dedicated) Read-only instance storage node specifications (Enterprise Edition DN) (General-purpose) rds.mysql.s2.xlarge 2 vCPUs, 8 GB (General-purpose) mysqlro.x4.large.1 4 vCPUs, 16 GB (General-purpose) mysqlro.x4.xlarge.1 8 vCPUs, 32 GB (General-purpose) mysqlro.x4.2xlarge.1 16 vCPUs, 64 GB (General-purpose) Read-only instance storage node specifications (Enterprise Edition DN) (Dedicated) mysqlro.x8.large.1 4 vCPUs, 32 GB (Dedicated) mysqlro.x8.xlarge.1 8 vCPUs, 64 GB (Dedicated) mysqlro.x8.2xlarge.1 16 vCPUs, 128 GB (Dedicated) mysqlro.x4.4xlarge.1 32 vCPUs, 128 GB (Dedicated) mysqlro.x8.4xlarge.1 32 vCPUs, 256 GB (Dedicated) rds.mysql.st.h43 60 vCPUs, 470 GB (Dedicated physical host) rds.mysql.st.v52 90 vCPUs, 720 GB (Dedicated physical host)	mysql.n4.medium.25
SpecifiedDNScale	boolean	No	Specifies whether to change the DN nodes to different specifications.	true
SpecifiedDNSpecMapJson	string	No	The target specification for each DN node when DN nodes are changed to different specifications.	{"pxc-xdb-s-htr3rh44ki3s6a4354":"mysql.n4.medium.25","pxc-xdb-s-htr3rh44ki3s6a71c6":"mysql.n4.medium.25"}
SwitchTimeMode	string	No	The switching time. Valid values: 0: Immediately. 1: Within the O&M window.	0
SwitchTime	string	No	The start time of the switchover. The switchover is performed within the period from the start time T to T+30 minutes. This parameter is not available.	2024-12-11T17:10:00Z
DnStorageSpace	string	No	The target cloud disk size after the specification change. If the instance uses a fixed-size cloud disk, you cannot change the cloud disk size. In this case, do not specify DnStorageSpace. Valid values of DnStorageSpace: 20 to 3072.	50
AlignStoragePrimaryAzone	boolean	No
StorageType	string	No	The target storage type.	cloud_auto

Response elements

Element	Type	Description	Example
	object
OrderId	string	The order ID. An order is generated when you upgrade or downgrade an instance, or change the instance specifications.	20211103105558
RequestId	string	The request ID.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
TaskId	integer	The ID of the instance specification change task.	0

Examples

Success response

JSON format

{
  "OrderId": "20211103105558",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "TaskId": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.