DeleteIndex - 删除知识库索引 - 大模型服务平台百炼

永久性删除指定的知识库。

接口说明

调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 IDIndexId有效）。
如果知识库正在被应用调用，需要先解除关联后才可删除。此操作当前只能通过控制台完成。具体操作请参见知识库。
删除操作不可逆，被删知识库将无法恢复，请谨慎操作。
调用本接口不会删除数据管理中已导入的文档。
本接口具有幂等性。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
sfm:DeleteIndex	none	全部资源 ``	无	无

请求语法

POST /{WorkspaceId}/index/delete HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
IndexId	string	是	知识库 ID，即 CreateIndex 接口返回的`Data.Id`。	f89ie0xxxx
WorkspaceId	string	是	知识库所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。	llm-3z7uw7fwz0vexxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	错误状态码。	Index.InvalidParameter
Message	string	错误信息。	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	请求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	接口返回的状态码。	200
Success	boolean	接口调用是否成功，可能值： true：成功 false：失败	true

示例

正常返回示例

JSON格式

{
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

错误码

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