空间操作

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

我的收藏

简介

本文档提供关于空间相关接口介绍以及示例代码。

列出空间首页内容

功能说明

用于列出空间首页内容。

示例代码

try {
let result = await SMHSpaceApis.listSpaceHomeFile({
libraryId:"libraryId",
spaceId:"spaceId",
filter:SMHDirectoryFilter.onlyDir,
limit:'5'
});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
marker
用于顺序列出分页的标识,翻页时传入此参数
String
limit
用于顺序列出分页时本地列出的项目数限制
String
filter
筛选方式,不传返回全部,onlyDir 只返回文件夹,onlyFile 只返回文件
SMHDirectoryFilter
category
文件自定义的分类,用户可通过更新文件接口修改文件的分类,也可以根据文件后缀预定义文件的分类信息
String
withPath
是否返回 path
Bool

查询租户空间大小

功能说明

用于查询租户空间大小。

示例代码

try {
let result = await SMHSpaceApis.getSpaceSize({
libraryId:"libraryId",
spaceId:"spaceId"
});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String

空间文件数量统计

功能说明

用于空间文件数量统计。

示例代码

try {
let result = await SMHSpaceApis.getSpaceFileCount({
libraryId:"libraryId",
spaceId:"spaceId"
});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String

设置租户空间限速

功能说明

用于设置租户空间限速。

示例代码

try {
let result = await SMHSpaceApis.setSpaceTrafficLimit({
libraryId:"libraryId",
spaceId:"spaceId",
downloadTrafficLimit:102400
});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
downloadTrafficLimit
空间下载限速,数字类型,范围 100KB/s - 100MB/s ,单位Byte,当输入 -1时表示取消限速
Number

列出租户空间列表信息

功能说明

用于列出租户空间列表信息。

示例代码

try {
let result = await SMHSpaceApis.listSpace({libraryId:"libraryId"});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
marker
用于顺序列出分页的标识,即上一次请求返回的 nextMarker 字段
String
limit
用于顺序列出分页时本地列出的项目数限制,默认为 1000,不能超过 1000
String

批量查询列出租户空间容量信息

功能说明

用于批量查询列出租户空间容量信息。

示例代码

try {
let result = await SMHSpaceApis.listSpaceUsage({
libraryId:"libraryId",
spaceIds:"spaceId"
});
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceIds
空间列表,以逗号分隔,如 space1,space2
String