ModifyDBClusterStoragePerformance - PolarDB - Alibaba Cloud Documentation Center

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

polardb:ModifyDBClusterStoragePerformance

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*************
ClientToken	string	No	A client-generated token that ensures request idempotence. The token must be unique for each request. It is case-sensitive and can be up to 64 ASCII characters long.	6000170000591aed949d0f******************
ProvisionedIops	integer	No		2500
StorageType	string	No	The target storage type. Valid values for Enterprise Edition: PSL5 PSL4 Valid values for Standard Edition: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	ESSDAUTOPL
BurstingEnabled	string	No	Specifies if the I/O performance burst feature is enabled for an ESSD AutoPL disk. Valid values: true: Enabled false: Disabled (Default) Note This parameter applies only when StorageType is set to ESSDAUTOPL.	false
ModifyType	string	No	The modification type. Valid values: Upgrade: Upgrades the storage performance. Downgrade: Downgrades the storage performance.	Upgrade

Response elements

Element	Type	Description	Example
	object
DBClusterId	string	The cluster ID.	pc-************
OrderId	string	The ID of the order.	2035629******
RequestId	string	The request ID.	E56531A4-E552-40BA-9C58-137B80******

Examples

Success response

JSON format

{
  "DBClusterId": "pc-************\t\n",
  "OrderId": "2035629******",
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTaskOperation	There is a cooling period after the storage performance is successfully modified.
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.	This series is not supported by the cluster.
404	InvalidParameterValue.Limit	Provisioned IOPS must less than %s, current is %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.