ModifyDBNodeHotReplicaMode - PolarDB - Alibaba Cloud Documentation Center

Enables or disables the failover with hot replica feature for a node in a 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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:ModifyDBNodeHotReplicaMode	update	*DBCluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster. Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.	pc-2vc327c2a14a3u858
DBNodeId	string	Yes	The ID of the node in the cluster.	pi-2ze28275h9x5r4wt1
HotReplicaMode	string	Yes	Specifies whether to enable the hot standby feature. Valid values: ON OFF	ON

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	9F4DDFBF-205C-5A3E-8DC2-C60F3E3FDC38
DBClusterId	string	The ID of the cluster. Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.	pc-2vc327c2a14a3u858
OrderId	string	The ID of the order.	2148126708*****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9F4DDFBF-205C-5A3E-8DC2-C60F3E3FDC38",
  "DBClusterId": "pc-2vc327c2a14a3u858",
  "OrderId": "2148126708*****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
404	InvalidDBInstanceClass.NotFound	rw class code must be equal with hot replica	The specification of the secondary node must be the same as that of the primary node.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBNodeId.NotFound	The DBNodeId provided does not exist in our records.	-

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

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2022-01-13	Add Operation	View Change Details