前期准备
开始操作前,确保您已经完成了 SDK 初始化。如果您还没有初始化 SDK,请先参考快速入门文档完成。
查询媒体库容量信息
功能说明
getLibraryUsage 用于查询媒体库的容量信息,返回媒体库所有文件占用的存储额度。需要 admin 权限。使用示例
import com.tencent.cloud.smh.ApiException;import com.tencent.cloud.smh.ApiResponse;import com.tencent.cloud.smh.api.UsageApi;import com.tencent.cloud.smh.model.GetLibraryUsage200Response;try {UsageApi.APIGetLibraryUsageRequest request = UsageApi.APIGetLibraryUsageRequest.newBuilder().libraryId("your-library-id").accessToken("your-access-token").build();ApiResponse<Object> apiResponse = client.usage().getLibraryUsageWithHttpInfo(request);if (apiResponse.getStatusCode() == 200) {GetLibraryUsage200Response result = (GetLibraryUsage200Response) apiResponse.getData();System.out.println("Total file size: " + result.getTotalFileSize() + " bytes");}} catch (ApiException e) {System.err.println("Error: " + e.getCode() + " - " + e.getMessage());}
参数说明
参数名 | 参数描述 | 类型 | 是否必填 |
libraryId | 媒体库 ID | String | 是 |
accessToken | 访问令牌;对于公有读媒体库或租户空间可不指定,否则需通过本参数传入或提前调用 client.withToken() 注入,二者取一 | String | 否 |
userId | 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份 | String | 否 |
返回值说明
HTTP 状态码:200,查询成功。
字段 | 说明 | 类型 |
totalFileSize | 媒体库所有文件占用存储额度,单位字节(Byte),字符串格式 | String |
批量查询租户空间容量信息
功能说明
getUsage 用于批量查询一个或多个租户空间的容量信息,包括配额、可用容量和已用容量。管理员可查询任意空间;space_admin 只能查询访问令牌所指定的空间。使用示例
import com.tencent.cloud.smh.ApiException;import com.tencent.cloud.smh.ApiResponse;import com.tencent.cloud.smh.api.UsageApi;import com.tencent.cloud.smh.model.GetUsage200ResponseInner;import java.util.List;try {UsageApi.APIGetUsageRequest request = UsageApi.APIGetUsageRequest.newBuilder().libraryId("your-library-id").spaceIds("space1,space2") // 多个空间 ID 用英文逗号分隔.accessToken("your-access-token").build();ApiResponse<Object> apiResponse = client.usage().getUsageWithHttpInfo(request);if (apiResponse.getStatusCode() == 200) {@SuppressWarnings("unchecked")List<GetUsage200ResponseInner> usages = (List<GetUsage200ResponseInner>) apiResponse.getData();for (var usage : usages) {System.out.println("Space: " + usage.getSpaceId()+ ", capacity: " + (usage.getCapacity() != null ? usage.getCapacity() : "无配额")+ ", available: " + (usage.getAvailableSpace() != null ? usage.getAvailableSpace() : "无配额")+ ", used: " + usage.getSize());}}} catch (ApiException e) {System.err.println("Error: " + e.getCode() + " - " + e.getMessage());}
参数说明
参数名 | 参数描述 | 类型 | 是否必填 |
libraryId | 媒体库 ID | String | 是 |
spaceIds | 租户空间 ID,多个空间 ID 使用英文逗号(,)分隔 | String | 是 |
accessToken | 访问令牌;对于公有读媒体库或租户空间可不指定,否则需通过本参数传入或提前调用 client.withToken() 注入,二者取一 | String | 否 |
userId | 用户身份识别 | String | 否 |
返回值说明
HTTP 状态码:200,查询成功,返回空间容量信息数组。
字段 | 说明 | 类型 |
spaceId | 租户空间 ID | String |
capacity | 空间配额,单位字节(Byte),字符串格式;为 null 表示无配额 | String |
availableSpace | 可用容量,单位字节(Byte),字符串格式;为 null 表示无配额 | String |
size | 已上传文件占用额度,单位字节(Byte),字符串格式 | String |