ForceSwitch - OpenSearch - Alibaba Cloud Documentation Center

Performs a forced switchover.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}

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 syntax

PUT /openapi/ha3/instances/{instanceId}/force-switch/{fsmId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-tl32m2c4u01
fsmId	string	Yes	The task ID.	tisplus_opensearch@roll_index_fsm@ha-cn-0ju2je4zj01@bj_vpc_domain_2@null@bj_vpc_domain_2_general_odps_false@1644312508597@934743

Sample requests

PUT /openapi/ha3/instances/{instanceId}/force-switch/tisplus_opensearch@add_index_config@106201777905****-ha-cn-0ju2i0e****_mx1228@null@index_11@null@164128272****@607017

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	0B1FF998-BB8D-5182-BFC0-E471AA77095A
result	object	The index information.	{}

Sample responses

Success responses

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": []

}

For more information, see Response struct.

Examples

Sample success responses

JSONformat

{
  "requestId": "0B1FF998-BB8D-5182-BFC0-E471AA77095A",
  "result": {}
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details