ReplaceDedicatedHost - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Replaces a host in a dedicated cluster.

Operation description

If you specify the manual host replacement policy when you create an ApsaraDB MyBase for MySQL dedicated cluster, you can call this operation to replace a faulty host in the dedicated cluster.

Note You can call the DescribeDedicatedHostAttribute operation to query the value of the HostStatus parameter.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the host. You can call the DescribeDedicatedHostAttribute operation to query the region ID.	cn-hangzhou
DedicatedHostId	string	Yes	The host ID. You can call the DescribeDedicatedHosts operation to query 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

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
404	InvalidDedicatedHostId_NotFound	specific DedicatedHostId not found

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