PolarDB:ModifyDBNodesClass - PolarDB - Alibaba Cloud - PolarDB

Changes the specifications of a single node in a PolarDB cluster.

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:ModifyDBNodesClass

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*************
ModifyType	string	Yes	The type of the specification change. Valid values: Upgrade: Upgrades the specifications. Downgrade: Downgrades the specifications.	Upgrade
DBNode	array<object>	Yes	The list of cluster nodes.
	object	No
DBNodeId	string	No	The cluster node ID. Note If this parameter is specified, DBNode.N.TargetClass is required. N is an integer that starts from 1. Maximum value: 16 minus the current number of nodes.	pi-*************
TargetClass	string	No	The specifications of the node to be changed. For more information about node specifications, see Compute node specifications. Note If this parameter is specified, DBNode.N.DBNodeId is required. N is an integer that starts from 1. Maximum value: 16 minus the current number of nodes.	polar.mysql.x4.medium
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
PlannedStartTime	string	No	The earliest time to start the scheduled (executed within the target time period) specification upgrade task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). Note This parameter takes effect only when `ModifyType` is set to `Upgrade`. The start time can be any time point within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`. If this parameter is left empty, the specification upgrade task is immediately executed by default.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). Note The latest time must be at least 30 minutes later than the start time. If `PlannedStartTime` is set but this parameter is not specified, the latest time to execute the task defaults to `start time + 30 minutes`. For example, if `PlannedStartTime` is set to `2021-01-14T09:00:00Z` and this parameter is left empty, the task starts no later than `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
SubCategory	string	No	The cluster sub-series. Valid values: normal_exclusive: Dedicated normal_general: General-purpose	normal_general
PlannedFlashingOffTime	string	No	The planned transient disconnection time. The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2021-01-14T09:30:00Z
CloudProvider	string	No	The cloud service provider to which the instance belongs.	ENS
AutoUseCoupon	boolean	No	Specifies whether to automatically use coupons. Valid values: true (default): Uses coupons. false: Does not use coupons.
PromotionCode	string	No	The coupon code. If this parameter is not specified, the default coupon is used.	727xxxxxx934

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	685F028C-4FCD-407D-A559-072D63******
DBClusterId	string	The database cluster ID.	pc-*************
OrderId	string	The order ID.	2035629******

Examples

Success response

JSON format

{
  "RequestId": "685F028C-4FCD-407D-A559-072D63******",
  "DBClusterId": "pc-*************",
  "OrderId": "2035629******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidModifyType.Malformed	The specified parameter ModifyType is not valid.	The specified ModifyType parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.