Temporarily upgrades the configuration of a PolarDB cluster or adds one or more 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
ClientToken String No 6000170000591aed949d0f5********************

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 value of this parameter is case-sensitive. The value can contain only ASCII characters and can be up to 64 characters in length.

Action String No TempModifyDBNode

The operation that you want to perform. Set the value to TempModifyDBNode.

DBClusterId String Yes pc-xxxxxxxxxx

The ID of the cluster.

OperationType String Yes Modify

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

  • Add: Add one or more nodes to the cluster.
  • Modify: Temporarily upgrade the configuration of the cluster.
ModifyType String Yes TempUpgrade

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

RestoreTime String Yes 2021-09-23 18:16:00

The rollback time of the configuration for the temporary upgrade. Specify the time 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.
DBNode.N.TargetClass String No polar.mysql.x4.medium

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

DBNode.N.ZoneId String No cn-hangzhou-i

The ID of the zone where the added node is deployed. The zone ID of the added node must be the same as the zone ID of original nodes.

Response parameters

Parameter Type Example Description
DBNodeIds Array of String pi-***************

The list of nodes.

Note If OperationType is set to Add, the value of this parameter is returned. If OperationType is set to Modify, no value is returned.
RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

The ID of the request.

DBClusterId String pc-xxxxxxxxxxxxxxxxx

The ID of the cluster.

OrderId String 2035638*******

The ID of the order.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?ClientToken=6000170000591aed949d0f5********************
&Action=TempModifyDBNode
&DBClusterId=pc-xxxxxxxxxx
&OperationType=Modify
&ModifyType=TempUpgrade
&DBNode=[{"TargetClass":"polar.mysql.x4.medium","ZoneId":"cn-hangzhou-i"}]
&RestoreTime=2021-09-23 18:16:00
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<TempModifyDBNodeResponse>
    <DBNodeIds>pi-***************</DBNodeIds>
    <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>
    <DBClusterId>pc-xxxxxxxxxxxxxxxxx</DBClusterId>
    <OrderId>2035638*******</OrderId>
</TempModifyDBNodeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The specified DBClusterId is not found. The error message returned because the specified cluster ID does not exist.

For a list of error codes, visit the API Error Center.