All Products
Search
Document Center

ApsaraDB for MyBase:ReplaceDedicatedHost

Last Updated:Aug 28, 2026

Replaces a host in a dedicated cluster.

Operation description

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

Note

Call the DescribeDedicatedHostAttribute operation to query the value of the HostStatus parameter.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID of the host. Call the DescribeDedicatedHostAttribute operation to query this value.

cn-hangzhou

DedicatedHostId

string

Yes

The host ID. Call the DescribeDedicatedHosts operation to query this value.

ch-bp10a5id3boqi****

FailoverMode

string

Yes

The switchover method for the primary instance. Valid values:

  • MaintainTime (default): The system switches workloads from the primary instance to the secondary instance on another host within a maintenance window, and then restarts the current host. This prevents service interruptions.

  • Immediate: The system immediately restarts the host.

MaintainTime

Response elements

Element

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

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

404 InvalidDedicatedHostId_NotFound specific DedicatedHostId not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.