Changes the specifications of a node in a PolarDB cluster.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:ModifyDBNodesClass | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The cluster ID. | pc-************* |
ModifyType | string | Yes | The type of the configuration change. Valid values:
| Upgrade |
DBNode | array<object> | Yes | The details of the nodes. | |
object | Yes | |||
DBNodeId | string | No | The ID of the node. Note
If you specify this parameter, DBNode.N.TargetClass is required. N is an integer that starts from 1. The maximum value of N is calculated by using the following formula:16 - The number of current nodes.
| pi-************* |
TargetClass | string | No | The specifications of the node that you want to change. For more information, see Specifications of compute nodes. Note
If you specify this parameter, DBNode.N.DBNodeId is required. N is an integer that starts from 1. The maximum value of N is calculated by using the following formula:16 - The number of current 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, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive. | 6000170000591aed949d0f54a343f1a4233c1e7d1c5c****** |
PlannedStartTime | string | No | The earliest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the Note
ModifyType is set to Upgrade .2021-01-14T09:00:00Z , you can specify a point in the time that ranges from 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z . | 2021-01-14T09:00:00Z |
PlannedEndTime | string | No | The latest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the Note
PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is set to Value of PlannedEndTime + 30 minutes . For example, if you set PlannedStartTime to 2021-01-14T09:00:00Z and you do not specify PlannedEndTime, the latest start time of the task is 2021-01-14T09:30:00Z . | 2021-01-14T09:30:00Z |
SubCategory | string | No | The category of the cluster. Valid values:
| normal_general |
Response parameters
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-29 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-09-12 | The Error code has changed | View Change Details |
2022-04-21 | Add Operation | View Change Details |