DeleteIndex - 刪除知識庫索引 -

介面說明

RAM 使用者（子帳號）需要首先擷取阿里雲百鍊的 API 許可權（需要AliyunBailianDataFullAccess，已包括 sfm:DeleteIndex 許可權點），並加入一個業務空間後，方可調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。
調用本介面前，請確保您的知識庫已經建立完成且未被刪除（即知識庫 IDIndexId有效）。
如果知識庫正在被應用調用，需要先解除關聯後才可刪除。此操作當前只能通過控制台完成。具體操作請參見知識庫。
刪除操作無法復原，被刪知識庫將無法恢複，請謹慎操作。
調用本介面不會刪除應用資料中已匯入的文檔。
本介面具有等冪性。

限流說明： 本介面頻繁調用會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。

調試

您可以在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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。