Switch PolarDB HA Architecture via ModifyDBClusterArch API - PolarDB - Alibaba Cloud - PolarDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:ModifyDBClusterArch

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	No	The cluster ID.	pc-****************
HotStandbyCluster	string	No	Specifies whether to enable the hot standby cluster. Valid values: on: Enables the hot standby cluster. equal: Enables the peer cluster.	on
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query region information.	cn-beijing
StandbyAZ	string	No	The zone of the hot standby storage cluster. Valid values: auto (default): Automatically selected. Note When the HotStandbyCluster parameter is set to on, you can use the default value. When the HotStandbyCluster parameter is set to equal, you must specify a specific zone. You can call the DescribeZones operation to query zone details.	cn-beijing-i
AutoUseCoupon	boolean	No	Specifies whether to automatically use coupons. Valid values: true (default): Uses coupons. false: Does not use coupons.
PromotionCode	string	No	The coupon code. If this parameter is not specified, the default coupon is used.	727xxxxxx934

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	6A2EE5B4-CC9F-46E1-A747-E43BC9******
DBClusterId	string	The cluster ID.	pc-**************
OrderId	string	The order ID.	2148126708*****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.