删除索引
功能介绍
删除指定索引。
URI
POST /v1/indexes/delete
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
store_name |
是 |
String |
参数解释: 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
collection_name |
是 |
String |
参数解释: collection名称,知识仓内唯一。 约束限制: 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
index_name |
是 |
String |
参数解释: 创建的索引名称,collection内唯一。 约束限制: 长度范围为1到255个字符,支持字母、数字、中划线(-)和下划线(_),大小写敏感。第一个字符只能够是下划线(_)和字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
{
"store_name" : "test-storename",
"collection_name" : "test-collection",
"index_name" : "vector_index"
}
响应示例
状态码:200
删除索引成功
{
"code" : "LMS.00000000",
"message" : "delete index success"
}
状态码:400
Bad Request
{
"code" : "LMS.00001001",
"message" : "ErrInvalidParameter: The input parameter is incorrect."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
删除索引成功 |
|
400 |
Bad Request |
错误码
请参见错误码。