MasterNodeShutDownFailOver - - Alibaba Cloud Documentation Center

Simulates database node failures.

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
kvstore:MasterNodeShutDownFailOver	none	*DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FailMode	string	No	Hard: stimulates a hardware failure that cannot be recovered. In this case, a high-availability switchover is triggered. Soft (default): stimulates a hardware failure that can be recovered. In this case, the system first attempts to recover the faulty node. If the attempt fails, a high-availability switchover is triggered. Valid values: Safe UnSafe Hard Soft	Safe
DBNodes	string	No	The IDs of the database nodes.	r-rdsdavinx01003-db-0,r-rdsdavinx01003-db-1
ProxyInstanceIds	string	No	The IDs of the proxy nodes.	6981,6982
ProxyFaultMode	string	No	Specify: This mode allows you to specify a proxy node to use. Random: In this mode, a random proxy node is selected when no proxy node is specified.	Specify
DBFaultMode	string	No	Specify: This mode allows you to specify a database node to use. Random: In this mode, a random database node is selected when no database node is specified.	Random
InstanceId	string	Yes	The instance ID. You can call the DescribeInstances operation to query the instance ID.	r-bp1zxszhcgatnx****
Category	string	No	The resource category. Set the value to instance.	instance

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	12123216-4B00-4378-BE4B-08005BFC****
DBInstanceId	string	The instance ID.	r-bp1zxszhcgatnx****
TaskID	string	The task ID.	17566

Examples

Sample success responses

JSONformat

{
  "RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
  "DBInstanceId": "r-bp1zxszhcgatnx****",
  "TaskID": "17566"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-12	The internal configuration of the API is changed, but the call is not affected	View Change Details