All Products
Search
Document Center

PolarDB:TempModifyDBNode

Last Updated:Mar 01, 2024

Temporarily upgrades a cluster or adds nodes to the cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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 can only contain ASCII characters and cannot exceed 64 characters in length.

6000170000591aed949d0f5********************
DBClusterIdstringYes

The cluster ID.

pc-xxxxxxxxxx
OperationTypestringYes

The type of operation performed on the cluster. Valid values:

  • Modify: temporarily upgrade the configuration of the cluster.
Modify
ModifyTypestringYes

The type of configuration change. Set the value to TempUpgrade.

TempUpgrade
DBNodeobject []Yes

The information of the added node.

TargetClassstringNo

The instance type of the added node. The instance type of the added node must be the same as the instance type of the original node.

Note You can call the DescribeDBClusters operation to view the instance types of original nodes.
polar.mysql.x4.medium
ZoneIdstringNo

The ID of the zone in which the added node is deployed. The instance type of the added node must be the same as the instance type of the original node.

cn-hangzhou-i
RestoreTimestringYes

The rollback time of the configuration for the temporary upgrade. Specify the time in the ISO 8601 standard in the YYYY-MM-DD hh:mm:ss format.

Note The rollback time cannot be 1 hour earlier than the current time and cannot be later than one day before the time when the cluster expires.
2021-09-23 18:16:00

Response parameters

ParameterTypeDescriptionExample
object
DBNodeIdsarray

The details of the nodes.

string

The details of the node.

Note If the OperationType parameter is set to Add, the value of this parameter is returned. If the OperationType parameter is set to Modify, no value is returned.
pi-***************
RequestIdstring

The request ID.

69A85BAF-1089-4CDF-A82F-0A140F******
DBClusterIdstring

The cluster ID.

pc-xxxxxxxxxxxxxxxxx
OrderIdstring

The ID of the order.

2035638*******

Examples

Sample success responses

JSONformat

{
  "DBNodeIds": [
    "pi-***************"
  ],
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "DBClusterId": "pc-xxxxxxxxxxxxxxxxx",
  "OrderId": "2035638*******"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBType.MalformedThe Specified DBType is not valid.The specified database type is invalid.
400InvalidDBNodeNum.MalformedThe number of parameter DBNode.N is not valid.The specified number of database nodes is invalid.
400InvalidDBNode.MalformedThe specified parameter DBNode.N is not valid.The specified DBNode.N parameter is invalid.
400InvalidModifyType.MalformedThe specified parameter ModifyType is not valid.The specified ModifyType parameter is invalid.
400InvalidZoneId.MalformedThe specified parameter ZoneId is not valid.The specified ZoneId parameter is invalid.
400InvalidDBNodeClass.MalformedThe specified parameter DBNodeClass is not valid.The specified DBNodeClass parameter is invalid.
404InvalidDBCluster.NotFoundThe specified DBClusterId is not found.The specified cluster ID does not exist.
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
404InvalidRestoreTimeExceedsExpirationTime.MalformedThe RestoreTime cannot be later than 1 day before the cluster ExpirationTime.The value of RestoreTime can be up to 1 day earlier than the expiration time of the cluster.
404InvalidCurrentTimeExceedsRestoreTime.MalformedThe RestoreTime cannot be 1 hour later than the CurrentTime.The value of RestoreTime cannot be 1 hour later than the value of CurrentTime.
404InvalidRestoreTime.MalformedThe specified RestoreTime is not valid.The specified RestoreTime parameter is invalid.
404InvalidOperationType.MalformedThe specified OperationType is not valid.The specified OperationType parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    Added Error Codes: 400