Changes the number of nodes in a PolarDB-X instance. You can call this operation to scale out or scale in a PolarDB-X instance. After you call this API operation, a transaction order is generated.


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
Action String Yes UpdatePolarDBXInstanceNode

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

RegionId String Yes cn-hanzhou

The region ID of the instance.

DBInstanceName String Yes pxc-hzjasdyuoo

The name of the instance. Valid values: 0-99.

DbInstanceNodeCount String Yes 3

The number of nodes after the scaling operation.

ClientToken String Yes FEA5DC20-6D8A-5979-97AA-FC57546ADC20

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.

Response parameters

Parameter Type Example Description
OrderId String 20211103105558

The ID of the order that is generated for this request.

RequestId String FEA5DC20-6D8A-5979-97AA-FC57546ADC20

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "OrderId" : "20211103105558",
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20"

Error codes

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