AlterSearchIndex - 修改搜索索引

修改搜索索引信息(索引状态或索引配置)。

调试

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

授权信息

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

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

请求参数

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

搜索库名称。

  • 未填写搜索库名称时,默认情况下搜索索引会被创建在 IMS 的默认搜索库下。默认值 ims-default-search-lib。
  • 您还可以通过 QuerySearchLib 接口查询已有的搜索库信息。
test1
IndexTypestring

索引类别。取值:

  • mm:大模型。
  • face:人脸。
  • aiLabel:智能标签。
mm
IndexStatusstring

索引状态。默认值为 Active,取值:

  • Active:激活。
  • Deactive:失效。

注意 必须填写 IndexStatus 或 IndexConfig 两个参数中的一个。

Active
IndexConfigstring

索引配置。

注意 必须填写 IndexStatus 或 IndexConfig 两个参数中的一个。

{}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

******3B-0E1A-586A-AC29-742247******
Successstring

是否调用成功。取值:

  • true: 成功
  • false:失败
true
Codestring

返回码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": "true",
  "Code": "200"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-23OpenAPI 入参发生变更查看变更详情
2023-11-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情