RestartDedicatedHost - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Restarts a host in a dedicated 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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
cddc:RestartDedicatedHost	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the host.	cn-hangzhou
DedicatedHostId	string	Yes	The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID.	ch-bp10a5id3boqi****
FailoverMode	string	Yes	The switchover method of the primary instance. Valid values: MaintainTime (default): The system performs a switchover within a maintenance window. The system switches workloads from the primary instance on the host to the secondary instance on another host, and then restarts the current host. This prevents service interruptions. Immediate: The system immediately restarts the host.	MaintainTime
ForceStop	boolean	No	Specifies whether to forcefully restart the host. Valid values: true: The system forcefully restarts the host. If this value is used, the system powers off the host. This results in the loss of cached data that is not written to storage. Exercise caution when you select this value. false (default): The system restarts the host normally. Note This parameter takes effect only for hosts that are created in ApsaraDB MyBase for Redis dedicated clusters of the Enhanced Edition (Tair). Hosts that are created in ApsaraDB MyBase dedicated clusters that run other database engines can be restarted normally.	false

Response parameters

Parameter	Type	Description	Example
	object
DedicatedHostId	string	The host ID.	ch-bp10a5id3boqi****
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22EDSH
TaskId	integer	The task ID.	10254125

Examples

Sample success responses

JSONformat

{
  "DedicatedHostId": "ch-bp10a5id3boqi****",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EDSH",
  "TaskId": 10254125
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.NotSupport	The userid have no permission.	-
403	InvalidAction.NotSupport	The host status does not support the operation.	The host status does not support the operation.
404	HostInfo.NotFound	Specified hostinfo is not found.	-

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

Change history

Change time	Summary of changes	Operation

No change history