ModifyDBInstanceClass - PolarDB - Alibaba Cloud Documentation Center

Calls the ModifyDBInstanceClass operation to modify the instance specifications.

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 specification changes Primary instance node specifications (Standard Edition) (General-purpose): mysql.n2.medium.25 2 cores, 4 GB (general-purpose) mysql.n4.medium.25 2 cores, 8 GB (general-purpose) mysql.n8.medium.25 2 cores, 16 GB (general-purpose) mysql.n2.large.25 4 cores, 8 GB (general-purpose) mysql.n4.large.25 4 cores, 16 GB (general-purpose) mysql.n8.large.25 4 cores, 32 GB (general-purpose) mysql.n2.xlarge.25 8 cores, 16 GB (general-purpose) mysql.n4.xlarge.25 8 cores, 32 GB (general-purpose) mysql.n8.xlarge.25 8 cores, 64 GB (general-purpose) mysql.n2.2xlarge.25 16 cores, 32 GB (general-purpose) mysql.n4.2xlarge.25 16 cores, 64 GB (general-purpose) mysql.n8.2xlarge.25 16 cores, 128 GB (general-purpose) Primary instance node specifications (Standard Edition) (Dedicated): mysql.x2.medium.25 2 cores, 4 GB (dedicated) mysql.x4.medium.25 2 cores, 8 GB (dedicated) mysql.x8.medium.25 2 cores, 16 GB (dedicated) mysql.x2.large.25 4 cores, 8 GB (dedicated) mysql.x4.large.25 4 cores, 16 GB (dedicated) mysql.x8.large.25 4 cores, 32 GB (dedicated) mysql.x2.xlarge.25 8 cores, 16 GB (dedicated) mysql.x4.xlarge.25 8 cores, 32 GB (dedicated) mysql.x8.xlarge.25 8 cores, 64 GB (dedicated) mysql.x2.2xlarge.25 16 cores, 32 GB (dedicated) mysql.x4.2xlarge.25 16 cores, 64 GB (dedicated) mysql.x8.2xlarge.25 16 cores, 128 GB (dedicated) Read-only instance node specifications (Standard Edition) General-purpose rds.mysql.s2.xlarge 2 cores, 8 GB (general-purpose) mysqlro.x4.large.1 4 cores, 16 GB (general-purpose) mysqlro.x4.xlarge.1 8 cores, 32 GB (general-purpose) mysqlro.x4.2xlarge.1 16 cores, 64 GB (general-purpose) Read-only instance node specifications (Standard Edition) Dedicated mysqlro.x8.large.1 4 cores, 32 GB (dedicated) mysqlro.x8.xlarge.1 8 cores, 64 GB (dedicated) mysqlro.x8.2xlarge.1 16 cores, 128 GB (dedicated) mysqlro.x4.4xlarge.1 32 cores, 128 GB (dedicated) mysqlro.x8.4xlarge.1 32 cores, 256 GB (dedicated)	mysql.n2.medium.25
ClientToken	string	No	The client token. This parameter is used to ensure the idempotence of the request. You can use any unique string.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
CnClass	string	No	Target specifications for Enterprise Edition compute node specification changes Primary instance compute node specifications (Enterprise Edition CN) General-purpose polarx.x4.medium.2e 2 cores, 8 GB (general-purpose) polarx.x4.large.2e 4 cores, 16 GB (general-purpose) polarx.x4.xlarge.2e 8 cores, 32 GB (general-purpose) polarx.x4.2xlarge.2e 16 cores, 64 GB (general-purpose) Primary instance compute node specifications (Enterprise Edition CN) Dedicated polarx.x8.large.2e 4 cores, 32 GB (dedicated) polarx.x8.xlarge.2e 8 cores, 64 GB (dedicated) polarx.x8.2xlarge.2e 16 cores, 128 GB (dedicated) polarx.x4.4xlarge.2e 32 cores, 128 GB (dedicated) polarx.x8.4xlarge.2e 32 cores, 256 GB (dedicated) polarx.st.8xlarge.2e 60 cores, 470 GB (dedicated) polarx.st.12xlarge.2e 90 cores, 720 GB (dedicated) Read-only instance compute node specifications (Enterprise Edition CN) General-purpose polarxro.x4.medium.2e 2 cores, 8 GB (general-purpose) polarxro.x4.large.2e 4 cores, 16 GB (general-purpose) polarxro.x4.xlarge.2e 8 cores, 32 GB (general-purpose) polarxro.x4.2xlarge.2e 16 cores, 64 GB (general-purpose) Read-only instance compute node specifications (Enterprise Edition CN) Dedicated polarxro.x8.large.2e 4 cores, 32 GB (dedicated) polarxro.x8.xlarge.2e 8 cores, 64 GB (dedicated) polarxro.x8.2xlarge.2e 16 cores, 128 GB (dedicated) polarxro.x4.4xlarge.2e 32 cores, 128 GB (dedicated) polarxro.x8.4xlarge.2e 32 cores, 256 GB (dedicated) polarxro.st.8xlarge.2e 60 cores, 470 GB (dedicated physical machine) polarxro.st.12xlarge.2e 90 cores, 720 GB (dedicated physical machine)	polarx.x4.medium.2e
DnClass	string	No	Target specifications for Enterprise Edition storage node specification changes Storage node specifications (Enterprise Edition DN) General-purpose mysql.n4.medium.25 2 cores, 8 GB (general-purpose) mysql.n4.large.25 4 cores, 16 GB (general-purpose) mysql.n4.xlarge.25 8 cores, 32 GB (general-purpose) mysql.n4.2xlarge.25 16 cores, 64 GB (general-purpose) Storage node specifications (Enterprise Edition DN) Dedicated mysql.x8.large.25 4 cores, 32 GB (dedicated) mysql.x8.xlarge.25 8 cores, 64 GB (dedicated) mysql.x8.2xlarge.25 16 cores, 128 GB (dedicated) mysql.x4.4xlarge.25 32 cores, 128 GB (dedicated) mysql.x8.4xlarge.25 32 cores, 256 GB (dedicated) mysql.st.8xlarge.25 60 cores, 470 GB (dedicated) mysql.st.12xlarge.25 90 cores, 720 GB (dedicated) Read-only instance storage node specifications (Enterprise Edition DN) General-purpose rds.mysql.s2.xlarge 2 cores, 8 GB (general-purpose) mysqlro.x4.large.1 4 cores, 16 GB (general-purpose) mysqlro.x4.xlarge.1 8 cores, 32 GB (general-purpose) mysqlro.x4.2xlarge.1 16 cores, 64 GB (general-purpose) Read-only instance storage node specifications (Enterprise Edition DN) Dedicated mysqlro.x8.large.1 4 cores, 32 GB (dedicated) mysqlro.x8.xlarge.1 8 cores, 64 GB (dedicated) mysqlro.x8.2xlarge.1 16 cores, 128 GB (dedicated) mysqlro.x4.4xlarge.1 32 cores, 128 GB (dedicated) mysqlro.x8.4xlarge.1 32 cores, 256 GB (dedicated) rds.mysql.st.h43 60 cores, 470 GB (dedicated physical machine) rds.mysql.st.v52 90 cores, 720 GB (dedicated physical machine)	mysql.n4.medium.25
SpecifiedDNScale	boolean	No	Specifies whether to perform a multi-specification change for DN nodes.	true
SpecifiedDNSpecMapJson	string	No	The target specification for each DN node when performing a multi-specification DN change.	{"pxc-xdb-s-htr3rh44ki3s6a4354":"mysql.n4.medium.25","pxc-xdb-s-htr3rh44ki3s6a71c6":"mysql.n4.medium.25"}
SwitchTimeMode	string	No	The switchover time. Valid values: 0: immediately. 1: within the O&M window.	0
SwitchTime	string	No	The switchover start time. The switchover time range is [start time T, T+30m]. This parameter is not yet available.	2024-12-11T17:10:00Z
DnStorageSpace	string	No	The target disk size for the specification change. If the instance uses a fixed-size disk, the disk cannot be changed. In this case, do not specify DnStorageSpace. Valid values of DnStorageSpace: [20, 3072].	50
		No
		No	Set this parameter to cloud_auto when migrating from local disks to cloud disks. If this parameter is not specified, the storage type remains unchanged.

Response elements

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

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.