删除目录或相簿

最近更新时间:2025-09-24 15:20:12

我的收藏

功能描述

用于删除目录或相簿。
说明:
要求权限:admin、space_admin 或 delete_directory(未开启回收站或 Permanent 为0)/delete_directory_permanent(开启回收站且 Permanent 为 1)。有关权限详情请参见 生成访问令牌接口
如果媒体库启用回收站功能,则该接口不会永久删除目录或相簿,而是将目录或相簿以及其下的文件移入回收站,可通过相关接口永久删除或恢复回收站内的目录或相簿,或直接清空回收站。

请求

请求示例

DELETE /api/v1/directory/ {LibraryId}/{SpaceId}/{DirPath}?permanent={Permanent}&access_token={AccessToken}&user_id={UserId}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
SpaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
DirPath
目录路径或相簿名,对于多级目录,使用斜杠(/)分隔,例如 foo/bar
String
Permanent
当媒体库开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,1: 永久删除,0: 移入回收站,默认为 0
String
AccessToken
访问令牌,获取请参见 生成访问令牌
String
UserId
用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参见 生成访问令牌接口
String

请求体

该请求无请求体。

响应

响应码

删除成功,返回 HTTP 204 No Content(未开启回收站)或 HTTP 200 OK(开启回收站)。

响应体

空,无响应体(未开启回收站)或 application/json(开启回收站)。
响应体示例:(开启回收站)
{
"recycledItemId": 123
}
响应体字段说明:
响应参数
描述
类型
recycledItemId
回收站项目 ID,用于从回收站永久删除或恢复指定项目
String

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。