DeleteIndex

​

Operation description

• Resource Access Management (RAM) users must first obtain API permissions for Model Studio (requiring AliyunBailianDataFullAccess, which includes the sfm:DeleteIndex permission) and join a workspace before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest Model Studio SDK to invoke this operation.
• Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID IndexId is valid).
• If the knowledge base is associated with an application, you must first dissociate it from the application before deleting it. This can currently only be done through the console. For more information, see Knowledge base.
• Deletion is irreversible. A deleted knowledge base cannot be recovered. Proceed with caution.
• Invoking this operation does not delete files that have been imported into Application Data.
• This operation has idempotence.

​

Try it now

​

RAM authorization

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
• API: The API that you can call to perform the action.
• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

​

Request syntax

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

​

Path Parameters

​

Request parameters

​

Response elements

​

Examples

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

​

Error codes

​

Release notes