Modifies the configurations of an AnalyticDB for MySQL 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
Action String Yes ModifyDBCluster

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

DBClusterId String Yes am-bpxxxxxxxx47

The ID of the cluster.

DBNodeGroupCount String No 2

The number of node groups. Valid values: 1 to 200.

Note This parameter is required when Mode is set to Reserver.
DBNodeStorage String No 200

The storage space of the node group. Unit: GB.

  • Valid values when DBClusterClass is set to C8: 100 to 2000
  • Valid values when DBClusterClass is set to C32: 100 to 8000
Note
  • This parameter is required when Mode is set to Reserver.
  • The storage space less than 1,000 GB increases in 100 GB increments. The storage space greater than 1,000 GB increases in 1,000 GB increments.
DBNodeClass String No C32

The specification of the cluster. Valid values:

  • C8
  • C32
    Note This parameter is required when Mode is set to Reserver.
ModifyType String No Upgrade

The type of the modification. Valid values:

  • Upgrade
  • Downgrade
ExecutorCount String No None

N/A

RegionId String No cn-hangzhou

The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list.

StorageResource String No None

N/A

ComputeResource String No 32Core128GB

The computing resources of the cluster. You can call the DescribeAvailableResource operation to query the computing resources that are available within a specific region.

Note This parameter is required when Mode is set to Flexible.
ElasticIOResource Integer No 0

The elastic I/O unit (EIU). For more information, see EIUs.

DBClusterCategory String No Cluster

The edition of the cluster. Valid values:

  • Cluster: reserved mode for Cluster Edition
  • MixedStorage: elastic mode for Cluster Edition
    Note When DBClusterCategory is set to Cluster, you must set Mode to Reserver. When DBClusterCategory is set to MixedStorage, you must set Mode to Flexible. Otherwise, the cluster cannot be created.
Mode String No Reserver

The mode of the cluster. Valid values:

  • Reserver: the reserved mode
  • Flexible: the elastic mode

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

DBClusterId String am-xxxxxxxxxxxxx

The ID of the cluster.

OrderId String 2035629xxxxxx

The ID of the order.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyDBCluster
&DBClusterId=am-bpxxxxxxxx47
&DBNodeGroupCount=2
&DBNodeStorage=200
&DBNodeClass=C32
&ModifyType=Upgrade
&ExecutorCount=None
&RegionId=cn-hangzhou
&StorageResource=None
&ComputeResource=32Core128GB
&ElasticIOResource=0
&DBClusterCategory=Cluster
&Mode=Reserver
&<Common request parameters>

Sample success responses

XML format

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

<ModifyDBClusterResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <DBClusterId>am-xxxxxxxxxxxxx</DBClusterId>
    <OrderId>2035629xxxxxx</OrderId>
</ModifyDBClusterResponse>

JSON format

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

{
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "DBClusterId" : "am-xxxxxxxxxxxxx",
  "OrderId" : "2035629xxxxxx"
}

Error codes

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