文档

ForceSwitch - 强制切换

强制切换。

接口说明

###方法

PUT

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ForceSwitchWrite
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id

ha-cn-tl32m2c4u01
fsmIdstring

任务 id

tisplus_opensearch@roll_index_fsm@ha-cn-0ju2je4zj01@bj_vpc_domain_2@null@bj_vpc_domain_2_general_odps_false@1644312508597@934743

请求示例

PUT /openapi/ha3/instances/{instanceId}/force-switch/tisplus_opensearch@add_index_config@1062017779051424-ha-cn-0ju2i0e5z01_mx1228@null@index_11@null@1641282725526@607017

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

id of request

0B1FF998-BB8D-5182-BFC0-E471AA77095A
resultobject

索引信息

{}

返回示例

正确返回 

{

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

  "result": []

}

详情可参考响应结构

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈