全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

Delete Index

最近更新时间:2026-11-03 19:52:57

描述

删除向量索引。使用此接口,您必须是这个 Bucket 的拥有者或拥有 ks3:DeleteIndex 权限。

删除后表内数据不可恢复,请谨慎操作。

请求

请求语法

POST /DeleteIndex HTTP/1.1
Host: ks3vectors-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Mon, 10 Dec 2025 12:49:14 GMT
Content-Type: application/json

{
  "vectorBucketName": "string",
  "indexName": "string"
}

使用索引 KRN 时,请求体为:

{
  "indexKrn": "string"
}

请求参数

该接口不使用请求参数。

请求头

该接口仅使用公共请求头。

请求体

请求体为一段删除向量索引的JSON:

参数

是否必填

类型

说明

indexKrn

否,与 indexName + vectorBucketName 严格二选一

string

索引资源名称(KRN),格式 krn:ksc:ks3vectors:<region>:<accountId>:bucket/<bucketName>/index/<indexName>。

indexArn

否,与 indexName + vectorBucketName 严格二选一

string

AWS4 签名协议下使用的字段名;KS3 签名协议下使用 indexKrn。二者不要同时提供。

indexName

否,构成 name 组合时必填,与 indexKrn/indexArn 互斥

string

索引名称。3-63 字符,仅小写字母和数字,首字符必须是字母;不允许 -、.,不允许数字开头。

vectorBucketName

否,构成 name 组合时必填,与 indexKrn/indexArn 互斥

string

向量桶名称。3-63 字符,仅小写字母、数字和连字符(-),首尾不得为连字符。

资源标识必须严格二选一:

  • 只提供 indexKrn(或 indexArn),或只提供 indexName + vectorBucketName。

  • 同时提供 indexKrn/indexArn 与 indexName、vectorBucketName 中任一字段,返回 400 IndexArnAndNameConflict。

  • 所有标识字段都不提供,返回 400 IndexInfoMissing;name 组合中缺少单个字段时,返回 400 单字段必填错误。

响应

响应头

该接口仅返回公共响应头。

响应体

该接口不返回响应体。

示例

请求示例

POST /DeleteIndex HTTP/1.1
Host: ks3vectors-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Mon, 10 Dec 2025 12:49:14 GMT
Content-Type: application/json

{
  "vectorBucketName": "example-bucket",
  "indexName": "exampleindex"
}

使用索引 KRN 时,请求体为:

{
  "indexKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket/index/exampleindex"
}

响应示例

HTTP/1.1 200 OK
Content-Length: 0
Date: Tue, 28 May 2025 03:19:14 GMT
Server: KS3
x-kss-request-id: NWNlY2E4YjFfNjljMDBiMDlfMmNiZTlfZGE0***

错误码

HTTP 状态码

错误码

描述

典型触发场景

400

ValidationException

请求参数不合法

indexKrn/indexArn 与 name 组合同时提供或都未提供;indexName 或 vectorBucketName 不符合命名规则;KRN 格式或 region 不合法。

403

AccessDeniedException

访问被拒绝

非桶拥有者且无 ks3:DeleteIndex 权限。

404

NotFoundException

资源不存在

指定的向量桶不存在(NoSuchBucket),或索引不存在(NoSuchVectorIndex)。

409

ConflictException

资源冲突

并发操作冲突(VectorIndexOperationConflict),或桶处于迁移状态(BucketInTransition)。

500

InternalServerException

服务内部错误

服务内部异常。

具体错误码通过响应头 x-kss-error-code 返回。

错误响应体格式如下:

{
  "message": "The indexName is invalid.",
  "fieldList": [
    {
      "path": "/indexName",
      "message": "..."
    }
  ]
}

fieldList 仅校验类错误(ValidationException)携带;其他错误只返回 message。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈