永久删除应用数据中的指定文件。不支持通过API删除数据表,详见下方接口说明。
接口说明
- 不支持通过 API 删除数据表。如需删除数据表或表中特定的数据,请前往应用数据操作。
- 本接口用于删除应用数据中的文件,不会影响已构建好的知识库。如需删除知识库中的文件,请调用 DeleteIndexDocument 接口。
- RAM 用户(子账号)需要首先获取阿里云百炼的 API 权限(需要
AliyunBailianDataFullAccess,已包括 sfm:DeleteFile 权限点),并加入一个业务空间后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。 - 本接口仅能删除状态为解析失败(PARSE_FAILED)或解析完成(PARSE_SUCCESS)的文件。
- 本接口具有幂等性。
限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
-
操作:是指具体的权限点。
-
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
-
条件关键字:是指云产品自身定义的条件关键字。
-
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
sfm:DeleteFile | delete | *全部资源
| 无 | 无 |
请求语法
DELETE /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1
路径参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileId | string | 是 | 文件 ID,即 AddFile 接口返回的 | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| WorkspaceId | string | 是 | 文件所属的业务空间 ID。获取方式请参见如何使用业务空间。 | llm-3shx2gu255oxxxx |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
当前API无需请求参数
返回参数
名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | 错误状态码。 | InvalidParameter |
| Data | object | 接口业务数据字段。 | |
| FileId | string | 文件 ID。 | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx |
| Message | string | 错误信息。 | Current file status does not support delete. |
| RequestId | string | 请求 ID。 | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | 接口返回的状态码。 | 200 |
| Success | boolean | 接口调用是否成功,可能值为:
| true |
示例
正常返回示例
JSON格式
{
"Code": "InvalidParameter",
"Data": {
"FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
},
"Message": "Current file status does not support delete.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。