All Products
Search

This Product

    Identity as a Service:ExecuteInstanceFailover

    Document Center

    Identity as a Service:ExecuteInstanceFailover

    Last Updated:Aug 19, 2026

    Performs a disaster recovery switchover.

    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
    InstanceId

    string

    Yes

    The replica instance ID.

    idaas_xxx
    InstanceFailoverStatus

    string

    Yes

    The failover status. Valid values:

    • inactive: The primary instance is active.

    • active: The replica instance is active.

    Valid values:

    • inactive :

      The primary instance is active.

    • active :

      The replica instance is active.

    active

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A

    Examples

    Success response

    JSON format

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.