All Products
Search
Document Center

PolarDB:ModifyDBClusterArch

Last Updated:May 29, 2025

Changes the high availability mode of the cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:ModifyDBClusterArchnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringNo

The ID of the cluster.

pc-****************
HotStandbyClusterstringNo

Specifies whether to enable the hot standby storage cluster feature. Valid values:

  • on: enables hot standby storage cluster.
  • equal: Enable a peer-to-peer cluster.
on
RegionIdstringNo

The region ID.

Note You can call the DescribeRegions operation to query information about regions.
cn-beijing
StandbyAZstringNo

The zone of the hot standby storage cluster. Valid values:

  • auto (default): The zone is automatically selected.
Note You can use the default value when HotStandbyCluster is set to on. If HotStandbyCluster is set to equal, specify the zone of the hot standby storage cluster. You can call the DescribeZones operation to query information about zones.
cn-beijing-i

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

6A2EE5B4-CC9F-46E1-A747-E43BC9******
DBClusterIdstring

The cluster ID.

pc-**************
OrderIdstring

The order ID.

2148126708*****

Examples

Sample success responses

JSONformat

{ "RequestId": "6A2EE5B4-CC9F-46E1-A747-E43BC9******", "DBClusterId": "pc-**************", "OrderId": "2148126708*****" }

Error codes

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