帮你快速理解、总结文档立即下载

用量统计

最近更新时间:2026-09-30 16:51:32
我的收藏

前期准备

开始操作前,确保您已经完成了 SDK 初始化。如果您还没有初始化 SDK,请先参考快速入门文档完成。

查询媒体库容量信息

功能说明
getLibraryUsage 用于查询媒体库的容量信息,返回媒体库所有文件占用的存储额度。需要 admin 权限。
使用示例
const res = await smh.usage.getLibraryUsage({});

if (res.status === 200) {
console.log('媒体库总用量:', res.data.totalFileSize, '字节');
}
返回值说明
HTTP 状态码:200,查询成功。
字段
说明
类型
totalFileSize
媒体库所有文件占用存储额度,单位字节(Byte),字符串格式
String

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

功能说明
getUsage 用于批量查询一个或多个租户空间的容量信息,包括配额、可用容量和已用容量。管理员可查询任意空间;space_admin 只能查询访问令牌所指定的空间。
使用示例
const res = await smh.usage.getUsage({
spaceIds: 'space1,space2', // 多个空间 ID 用英文逗号分隔
});

if (res.status === 200) {
// 注意:返回的是数组
res.data.forEach(usage => {
console.log('空间:', usage.spaceId,
'配额:', usage.capacity ?? '无配额',
'可用:', usage.availableSpace ?? '无配额',
'已用:', usage.size);
});
}
参数说明
参数名
参数描述
类型
是否必填
spaceIds
租户空间 ID,多个空间 ID 使用英文逗号(,)分隔
String
是
userId
用户身份识别
String
否
返回值说明
HTTP 状态码:200,查询成功,返回空间容量信息数组。
字段
说明
类型
spaceId
租户空间 ID
String
capacity
空间配额,单位字节(Byte),字符串格式;为 null 表示无配额
String
availableSpace
可用容量,单位字节(Byte),字符串格式;为 null 表示无配额
String
size
已上传文件占用额度,单位字节(Byte),字符串格式
String