ModifyDBNodesClass-阿里云帮助中心

Modifies 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 modification type. 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 ID of the cluster node. Note If you specify this parameter, you must also specify DBNode.N.TargetClass. N represents the index of the node in the request, starting from 1.	pi-*************
TargetClass	string	No	The target specifications of the node. For more information about node specifications, see compute node specifications. Note If you specify this parameter, you must also specify DBNode.N.DBNodeId. N represents the index of the node in the request, starting from 1.	polar.mysql.x4.medium
ClientToken	string	No	A client-generated token to ensure request idempotence. This token must be unique for each request and must be a case-sensitive string of up to 64 ASCII characters.	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
PlannedStartTime	string	No	The earliest time to begin the scheduled upgrade of the node specifications. Specify the time in UTC using the `YYYY-MM-DDThh:mm:ssZ` format. Note This parameter takes effect only when `ModifyType` is set to `Upgrade`. The specified time must be within the next 24 hours. If this parameter is not specified, the upgrade task runs immediately.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	The latest time to begin the scheduled task. Specify the time in UTC using the `YYYY-MM-DDThh:mm:ssZ` format. Note The latest start time must be at least 30 minutes later than the earliest start time. If you specify `PlannedStartTime` but not this parameter, the task starts within 30 minutes of the `PlannedStartTime`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task will start by `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
SubCategory	string	No	The sub-category of the cluster. Valid values: normal_exclusive: dedicated specifications normal_general: general-purpose specifications	normal_general
PlannedFlashingOffTime	string	No	The planned time for the transient disconnection.	2021-01-14T09:30:00Z
CloudProvider	string	No	The cloud provider of the instance.	ENS
AutoUseCoupon	boolean	No	Specifies whether to automatically apply a coupon. Valid values: true (Default): A coupon is automatically applied. false: A coupon is not applied.
PromotionCode	string	No	The coupon code. If you do not specify this parameter, a default coupon is applied.	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.