All Products
Search

This Product

    ApsaraDB for MyBase:RestartDedicatedHost

    Document Center

    ApsaraDB for MyBase:RestartDedicatedHost

    Last Updated:Aug 28, 2026

    Restarts a host in a dedicated cluster.

    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.

    cn-hangzhou
    DedicatedHostId

    string

    Yes

    The host ID. You can view the host ID on the Hosts page in the ApsaraDB for MyBase console.

    ch-bp10a5id3boqi****
    FailoverMode

    string

    Yes

    The switchover method of the primary instance. Valid values:

    • MaintainTime (default): Performs a switchover within a maintenance window. Workloads are switched from the primary instance on the host to the secondary instance on another host before the current host is restarted. This prevents service interruptions.

    • Immediate: Immediately restarts the host.

    MaintainTime
    ForceStop

    boolean

    No

    Whether to forcefully restart the host. Valid values:

    • true: Forcefully restarts the host by powering it off. Cached data that has not been written to storage is lost. Use with caution.

    • false (default): Restarts the host normally.

    Note

    This parameter applies only to hosts in ApsaraDB MyBase for Redis dedicated clusters of the Enhanced Edition (Tair). Hosts in ApsaraDB MyBase dedicated clusters that run other database engines are restarted normally.

    false

    Response elements

    Element

    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

    Success response

    JSON format

    {
  "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.