AI 助理
文档备案控制台
官方文档
首页

AlterSearchIndex - 修改搜索索引

更新时间：
复制 MD 格式
产品详情
我的收藏

修改搜索索引信息（索引状态或索引配置）。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:AlterSearchIndex

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
SearchLibName

string

否

搜索库名称。

  • 未填写搜索库名称时，默认情况下搜索索引会被创建在 IMS 的默认搜索库下。默认值 ims-default-search-lib。

  • 您还可以通过 QuerySearchLib 接口查询已有的搜索库信息。

test1
IndexType

string

是

索引类别。取值：

  • mm：大模型。

  • face：人脸。

  • aiLabel：智能标签。

枚举值：

  • mm :

    mm

  • face :

    face

  • aiLabel :

    aiLabel

mm
IndexStatus

string

否

索引状态。默认值为 Active，取值：

  • Active：激活。

  • Deactive：失效。

重要 必须填写 IndexStatus 或 IndexConfig 两个参数中的一个。

枚举值：

  • Active :

    Active

  • Deactive :

    Deactive

Active
IndexConfig

string

否

索引配置。

重要 必须填写 IndexStatus 或 IndexConfig 两个参数中的一个。

{}

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

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

string

是否调用成功。取值：

  • true： 成功

  • false：失败

true
Code

string

返回码。

200

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：CreateSearchIndex - 创建搜索索引下一篇：QuerySearchIndex - 查询搜索索引