すべてのプロダクト
Search

このプロダクト

    :DeleteIndex

    ドキュメントセンター

    :DeleteIndex

    最終更新日:Aug 13, 2025

    指定されたナレッジベースを完全に削除します。

    操作説明

    • RAM ユーザーはこの操作を呼び出すために、Alibaba Cloud Model Studio に必要な API 権限 を持ち、ワークスペース のメンバーである必要があります。 `sfm:DeleteIndex` 権限を含む `AliyunBailianDataFullAccess` 権限が必要です。Alibaba Cloud アカウントは、承認なしでこの操作を直接呼び出すことができます。この操作を呼び出すには、最新の Alibaba Cloud Model Studio SDK を使用してください。

    • この操作を呼び出す前に、ナレッジベースが作成済みで、削除されていないことを確認してください。ナレッジベース ID（`IndexId`）は有効である必要があります。

    • アプリケーションがナレッジベースを使用している場合は、削除する前にアプリケーションから関連付けを解除する必要があります。この操作は [コンソール] のみで実行できます。詳細については、「ナレッジベース」をご参照ください。

    • 削除操作は元に戻せません。削除されたナレッジベースは回復できません。慎重に行ってください。

    • この操作では、 アプリケーションデータ にインポートされたドキュメントは削除されません。

    • この操作はべき等です。

    スロットリング この操作への頻繁な呼び出しはスロットルされます。1 秒あたり 10 回を超えないでください。呼び出しがスロットルされた場合は、後で再試行してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:DeleteIndex

    none

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    IndexId

    string

    必須

    ナレッジベースの ID。これは、CreateIndex 操作によって返される `Data.Id` 値です。

    f89ie0xxxx
    WorkspaceId

    string

    必須

    ナレッジベースが属するワークスペースの ID。ID の取得方法については、「ワークスペースの使用方法」をご参照ください。

    llm-3z7uw7fwz0vexxxx

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    レスポンススキーマ。

    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

    例

    成功レスポンス

    JSONJSON

    {
  "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
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。