云盒Bucket内的文件(Object)默认按照字母序排列。您可以结合实际场景列举当前云盒Bucket的所有Object、指定前缀的Object、指定个数的Object等。
使用阿里云SDK
支持通过Java、Python、Go SDK列举云盒Bucket内的所有Object(Java SDK要求3.15.0及以上版本,Python SDK V2要求1.1.1及以上版本,Go SDK V2要求v1.2.1及以上版本)。云盒场景下,Python、Go SDK的操作调用方式与公共云OSS一致,创建客户端的方式请参见SDK支持。以下代码示例分别以Java、Python、Go SDK为例。
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.*;
import java.util.List;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
public class Demo {
public static void main(String[] args) throws Exception {
// 填写云盒Bucket的数据域名。
String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-heyuan.oss-cloudbox.aliyuncs.com";
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 填写云盒Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 填写云盒Bucket所在地域。
String region = "cn-hangzhou";
// 填写云盒ID。
String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";
// 指定前缀,例如exampledir/object。
String keyPrefix = "exampledir/object";
// 创建OSSClient实例。
// 当OSSClient实例不再使用时,调用shutdown方法以释放资源。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
conf.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
.clientConfiguration(conf)
.region(region)
.cloudBoxId(cloudBoxId)
.build();
try {
// 列举Object。如果不设置keyPrefix,则列举云盒Bucket下的所有Object。如果设置keyPrefix,则列举包含指定前缀的Object。
ObjectListing objectListing = ossClient.listObjects(bucketName, keyPrefix);
List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
for (OSSObjectSummary s : sums) {
System.out.println("\t" + s.getKey());
}
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
} # -*- coding: utf-8 -*-
import alibabacloud_oss_v2 as oss
# 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# 使用SDK的默认配置。
cfg = oss.config.load_default()
cfg.credentials_provider = credentials_provider
# 设置Region为云盒所在的地域,例如cn-hangzhou。
cfg.region = "cn-hangzhou"
# 设置云盒ID。设置云盒ID后,SDK会自动将签名产品切换为oss-cloudbox。
cfg.cloud_box_id = "cb-f8z7yvzgwfkl9q0h****"
# 设置访问域名,格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
cfg.endpoint = "cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com"
# 创建OSS客户端。
client = oss.Client(cfg)
# 填写Bucket名称,例如examplebucket。
bucket_name = "examplebucket"
# 指定前缀。如果不设置prefix,则列举云盒Bucket下的所有Object;如果设置prefix,则列举包含指定前缀的Object。
key_prefix = "exampledir/object"
# 创建列举Object的分页器。
paginator = client.list_objects_v2_paginator()
# 遍历每一页并打印Object信息。
for page in paginator.iter_page(oss.ListObjectsV2Request(
bucket=bucket_name,
prefix=key_prefix,
)
):
for o in page.contents:
print(f'Object: {o.key}, {o.size}, {o.last_modified}')package main
import (
"context"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
func main() {
// 加载SDK的默认配置,并设置访问凭证、地域、云盒ID及访问域名。
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
// 设置Region为云盒所在的地域,例如cn-hangzhou。
WithRegion("cn-hangzhou").
// 设置访问域名,格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
WithEndpoint("cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com").
// 设置云盒ID。设置云盒ID后,SDK会自动将签名产品切换为oss-cloudbox。
WithCloudBoxId("cb-f8z7yvzgwfkl9q0h****")
// 创建OSS客户端。
client := oss.NewClient(cfg)
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 指定前缀。如果不设置Prefix,则列举云盒Bucket下的所有Object;如果设置Prefix,则列举包含指定前缀的Object。
keyPrefix := "exampledir/object"
request := &oss.ListObjectsV2Request{
Bucket: oss.Ptr(bucketName),
Prefix: oss.Ptr(keyPrefix),
}
// 创建列举Object的分页器。
p := client.NewListObjectsV2Paginator(request)
// 遍历每一页并打印Object信息。
log.Println("Objects:")
for p.HasNext() {
page, err := p.NextPage(context.TODO())
if err != nil {
log.Fatalf("failed to get page %v", err)
}
for _, obj := range page.Contents {
log.Printf("Object:%v, %v, %v\n", oss.ToString(obj.Key), obj.Size, oss.ToTime(obj.LastModified))
}
}
}使用命令行工具ossutil
关于使用ossutil列举Object的具体操作, 请参见list-objects(get-bucket)。
使用REST API
如果您的程序自定义要求较高,您可以直接发起REST API请求。直接发起REST API请求需要手动编写代码计算签名。
您可以通过API中的GetBucket (ListObjects)或ListObjectsV2(GetBucketV2)接口列举Bucket中的Object。建议您在开发应用程序时使用较新的版本GetBucketV2 (ListObjectsV2)。为保证向后兼容性,OSS继续支持GetBucket (ListObjects)。
该文章对您有帮助吗?