UpdatePrivateRdsClass - 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

drds:UpdatePrivateRdsClass

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RdsClass	string	No	The updated instance type code of the storage layer custom RDS instance. Note You can call the DescribeAvailableClasses operation to query the available instance types for storage layer custom RDS instances, including instance type codes and storage capacity ranges.	rds.mysql.c1.xlarge
DrdsInstanceId	string	Yes	The ID of the DRDS instance. Note You can call the DescribeDrdsInstances operation to query the details of all instances within the specified account, including instance IDs.	drds*************
DBInstanceId	string	Yes	The ID of the storage layer custom RDS instance. > You can call the DescribeDrdsRdsInstances operation to query the details of all storage layer RDS instances under the specified DRDS instance, including instance IDs.	rm-***************
Storage	string	No	The updated storage capacity of the storage layer custom RDS instance. Note You can call the DescribeAvailableClasses operation to query the available instance types for storage layer custom RDS instances, including instance type codes and storage capacity ranges.	50
AutoUseCoupon	boolean	No	Specifies whether to use a voucher to offset the purchase fee. Valid values: true and false (default). Note If you use a voucher and later downgrade the instance, the amount offset by the voucher will not be refunded.	true
PrePayDuration	integer	No	Invalid field.	12

Response elements

Element	Type	Description	Example
	object
Data	string	The order ID.	{ "orderId": "209136011******" }
RequestId	string	The request ID.	57D86AB4-8703-4DF4-BAB6-F7DE44******
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Data": "{     \"orderId\": \"209136011******\"   }",
  "RequestId": "57D86AB4-8703-4DF4-BAB6-F7DE44******",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
500	ModifyRdsClassApiError	Failed to modify the class of the RDS instance.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.