停用索引-DisableVikingdbIndex--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

索引(Index)

停用索引-DisableVikingdbIndex

概述

接口用于停用指定处于“已就绪”状态的索引。停用后索引将释放相关内存资源，且无法继续使用；如需继续使用，则需启用该索引。启用索引请参见启用索引-EnableVikingdbIndex。

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时，可以使用 ak、sk 构造签名进行鉴权。请参见控制面API调用流程，复制调用示例并填入必要信息

请求参数

请求参数Action取值：DisableVikingdbIndex。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请参见公共参数。

参数	类型	是否必填	描述
ProjectName	String	否	项目名称
CollectionName	String	2选1	数据集名称
ResourceId	String	2选1	数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。
IndexName	String	是	索引名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Message	String	success	操作结果信息

请求示例

action = "DisableVikingdbIndex"
body = {
  "CollectionName": "aa",
  "IndexName": "Zfg0D"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251226143245108247224207F9BA68",
    "Action": "DisableVikingdbIndex",
    "Version": "2025-06-09",
    "Service": "vikingdb_stg",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "success"
  }
}

错误码

错误码请参见公共错误码文档。

最近更新时间：2026.04.14 17:18:22

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码