DeleteFiles - 批量删除文件

更新时间:
复制 MD 格式

批量删除文件

接口说明

  • 不支持通过 API 删除数据表。如需删除数据表或表中特定的数据,请前往应用数据操作。

  • 本接口用于删除应用数据中的文件,不会影响已构建好的知识库。如需删除知识库中的文件,请调用 DeleteIndexDocument 接口。

  • RAM 用户(子账号)需要首先获取阿里云百炼的 API 权限(需要AliyunBailianDataFullAccess,已包括 sfm:DeleteFiles 权限点),并加入一个业务空间后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。

  • 本接口仅能删除状态为解析失败(PARSE_FAILED)或解析完成(PARSE_SUCCESS)的文件。

  • 本接口具有幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /{WorkspaceId}/datacenter/file/delete HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

WorkspaceId

string

类目所属的业务空间 ID。获取方式请参见如何使用业务空间

llm-mbhn96xxxx

请求参数

名称

类型

必填

描述

示例值

FileIds

array

需要删除的文件 id 列表,单次删除最多支持 20 个文件

string

需要删除的文件 id

file_xxxx

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

string

错误状态码。

DataCenter.FileTooLarge

Data

object

返回内容

DeleteFileResultList

array<object>

删除结果

object

单个文件删除结果

FileId

string

文件 ID。

file_6b193b9b4b1546ef9eaa7340e69adfca_10052857

Status

string

文件删除状态。状态可能值为:

  • DELETED:删除成功。

  • FAILED:删除失败。

  • NOT_FOUND:未查询到文件

DELETED

Message

string

错误信息。

Required parameter(%s) missing or invalid, please check the request parameters.

RequestId

string

Id of the request

17204B98-7734-4F9A-8464-2446A84821CA

Status

string

接口返回的状态码。

200

Success

boolean

接口调用是否成功,可能值为:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "DeleteFileResultList": [
      {
        "FileId": "file_6b193b9b4b1546ef9eaa7340e69adfca_10052857",
        "Status": "DELETED"
      }
    ]
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-7734-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情