批量处理

最近更新时间:2025-09-29 11:21:32

我的收藏

简介

本文档提供关于批量处理相关接口介绍以及示例代码。

批量删除目录或文件

功能说明

用于批量删除目录或文件。

示例代码

try {
let items :SMHBatchDeleteObject[] = [
{path:`test/key1`,permanent:false},
{path:`test/key2`,permanent:false}
]
let result = await SMHBatchApis.batchDeleteFile({
libraryId: "libraryId",
spaceId: "spaceId",
items: items
});
} catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
items
批量操作项的集合
SMHBatchDeleteObject 数组
path
被删除的目录、相簿或文件路径
String
permanent
当开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,true: 永久删除,false: 移入回收站,默认为 false
Bool

批量复制目录或文件

功能说明

用于批量复制目录或文件。

示例代码

try {
let items :SMHBatchCopyObject[] = [
{copyFrom:`test/key1`,to:`test/key1_copy`},
{copyFrom:`test/key2`,to:`test/key2_copy`},
]
let result = await SMHBatchApis.batchCopyFile({
libraryId: "libraryId",
spaceId: "spaceId",
items: items
});
} catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
items
批量操作项的集合
SMHBatchCopyObject 数组
to
目标目录、相簿或文件路径,例如 foo/bar/file_new.docx
String
copyFrom
被复制的源目录、相簿或文件路径
String
copyFromSpaceId
跨空间复制时指定源目录或文件所在的空间,同空间复制时请勿指定该字段
String
conflictResolutionStrategy
文件名冲突时的处理方式,如果目标为目录或相簿时,默认为 ask 且不支持 overwrite,如果目标为文件默认为 rename
ask: 冲突时返回
status: 409 及 SameNameDirectoryOrFileExists 错误码
rename: 冲突时自动重命名文件
overwrite: 如果冲突目标为目录时返回 status 409 及 SameNameDirectoryOrFileExists 错误码,否则覆盖已有文件
SMHConflictResolutionStrategy

批量重命名或移动目录/文件

功能说明

用于批量重命名或移动目录/文件。

示例代码

try {
let items :SMHBatchMoveObject[] = [
{from:`test/key1`,to:`test/key1_move`},
{from:`test/key2`,to:`test/key2_move`},
]
let result = await SMHBatchApis.batchMoveFile({
libraryId: "libraryId",
spaceId: "spaceId",
items: items
});
} catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
items
批量操作项的集合
SMHBatchMoveObject 数组
to
目标目录、相簿或文件路径,例如 foo/bar/file_new.docx
String
from
被重命名或移动的源目录、相簿或文件路径
String
copyFromSpaceId
跨空间移动时指定源目录或文件所在的空间,同空间移动时请勿指定该字段
String
conflictResolutionStrategy
文件名冲突时的处理方式,如果目标为目录或相簿时,默认为 ask 且不支持 overwrite,如果目标为文件默认为 rename
ask: 冲突时返回
status: 409 及 SameNameDirectoryOrFileExists 错误码
rename: 冲突时自动重命名文件
overwrite: 如果冲突目标为目录时返回 status 409 及 SameNameDirectoryOrFileExists 错误码,否则覆盖已有文件
SMHConflictResolutionStrategy