简介
本文档提供关于列出对象操作相关的 API 概览以及 SDK 示例代码。
注意事项
若您要使用列出对象功能，需要先具有目标桶的读取权限：在您进行 授权策略 时，action 需要设置为
cos:GetBucket ，更多授权请参见 支持CAM的业务接口。若您要使用列出对象历史版本功能，需要先具有目标桶的读取权限：在您进行 授权策略 时，action 需要设置为
cos:GetBucketObjectVersions ，更多授权请参见 支持CAM的业务接口。相关示例
功能名称 | 描述 | 示例代码 |
列出对象 | 提供了查询存储桶下的部分或者全部对象、查询存储桶下的部分或者全部对象及其历史版本信息的能力。 | |
列出对象历史版本 | 提供了查询存储桶内的所有对象及其历史版本信息，您可以通过指定参数筛选出存储桶内部分对象及其历史版本信息。 |
查询对象列表
功能说明
查询存储桶下的部分或者全部对象。
使用案例
获取第一页数据
Objective-C
QCloudGetBucketRequest* request = [QCloudGetBucketRequest new];// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketrequest.bucket = @"examplebucket-1250000000";// 单次返回的最大条目数量，默认1000request.maxKeys = 100;// 前缀匹配，用来规定返回的文件前缀地址request.prefix = @"dir1/";[request setFinishBlock:^(QCloudListBucketResult * result, NSError* error) {// result 返回具体信息// QCloudListBucketResult.contents 桶内文件数组// QCloudListBucketResult.commonPrefixes 桶内文件夹数组if (result.isTruncated) {// 表示数据被截断，需要拉取下一页数据self->prevPageResult = result;}}];[[QCloudCOSXMLService defaultCOSXML] GetBucket:request];
Swift
let getBucketReq = QCloudGetBucketRequest.init();// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketgetBucketReq.bucket = "examplebucket-1250000000";// 单次返回的最大条目数量，默认1000getBucketReq.maxKeys = 100;// 前缀匹配getBucketReq.prefix = "dir/";getBucketReq.setFinish { (result, error) inif let result = result {// 文件列表let contents = result.contentsif (result.isTruncated) {// 数据被截断，需要请求下一页数据self.prevPageResult = result;}} else {print(error!);}}QCloudCOSXMLService.defaultCOSXML().getBucket(getBucketReq);
请求下一页数据
Objective-C
QCloudGetBucketRequest* request = [QCloudGetBucketRequest new];// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketrequest.bucket = @"examplebucket-1250000000";// prevPageResult 是上一页的返回结果// 分页参数 默认以UTF-8二进制顺序列出条目，所有列出条目从marker开始request.marker = prevPageResult.nextMarker;// 单次返回的最大条目数量，默认1000request.maxKeys = 100;[request setFinishBlock:^(QCloudListBucketResult * result, NSError* error) {// result 返回具体信息// QCloudListBucketResult.contents 桶内文件数组// QCloudListBucketResult.commonPrefixes 桶内文件夹数组if (result.isTruncated) {// 表示数据被截断，需要拉取下一页数据self->prevPageResult = result;}}];[[QCloudCOSXMLService defaultCOSXML] GetBucket:request];
Swift
let getBucketReq = QCloudGetBucketRequest.init();// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketgetBucketReq.bucket = "examplebucket-1250000000";// 分页参数 默认以UTF-8二进制顺序列出条目，所有列出条目从marker开始if let result = self.prevPageResult {getBucketReq.marker = result.marker}// 单次返回的最大条目数量，默认1000getBucketReq.maxKeys = 100;// 前缀匹配getBucketReq.prefix = "dir/";getBucketReq.setFinish { (result, error) inif let result = result {// 文件列表let contents = result.contentsif (result.isTruncated) {// 数据被截断，需要请求下一页数据self.prevPageResult = result;}} else {print(error!);}}QCloudCOSXMLService.defaultCOSXML().getBucket(getBucketReq);
获取对象列表与子目录
Objective-C
QCloudGetBucketRequest* request = [QCloudGetBucketRequest new];// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketrequest.bucket = @"examplebucket-1250000000";// 单次返回的最大条目数量，默认1000request.maxKeys = 100;// 前缀匹配，用来规定返回的文件前缀地址request.prefix = @"dir1/";// 定界符为一个符号，如果有 Prefix，则将 Prefix 到 delimiter 之间的相同路径归为一类，// 定义为 Common Prefix，然后列出所有 Common Prefix。如果没有 Prefix，则从路径起点开始// delimiter:路径分隔符 固定为 /request.delimiter = @"/";// prevPageResult 是上一页的返回结果// 分页参数 默认以UTF-8二进制顺序列出条目，所有列出条目从marker开始request.marker = prevPageResult.nextMarker;[request setFinishBlock:^(QCloudListBucketResult * result, NSError* error) {// result 返回具体信息// QCloudListBucketResult.contents 桶内文件数组// QCloudListBucketResult.commonPrefixes 桶内文件夹数组if (result.isTruncated) {// 表示数据被截断，需要拉取下一页数据self->prevPageResult = result;}}];[[QCloudCOSXMLService defaultCOSXML] GetBucket:request];
Swift
let getBucketReq = QCloudGetBucketRequest.init();// 存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucketgetBucketReq.bucket = "examplebucket-1250000000";// 单次返回的最大条目数量，默认1000getBucketReq.maxKeys = 100;// 前缀匹配，用来规定返回的文件前缀地址getBucketReq.prefix = "dir/";// 定界符为一个符号，如果有 Prefix，则将 Prefix 到 delimiter 之间的相同路径归为一类，// 定义为 Common Prefix，然后列出所有 Common Prefix。如果没有 Prefix，则从路径起点开始// delimiter:路径分隔符 固定为 /getBucketReq.delimiter = "/";// 分页参数 默认以UTF-8二进制顺序列出条目，所有列出条目从marker开始if let result = self.prevPageResult {getBucketReq.marker = result.marker}getBucketReq.setFinish { (result, error) inif let result = result {// 文件列表let contents = result.contentsif (result.isTruncated) {// 数据被截断，需要请求下一页数据self.prevPageResult = result;}} else {print(error!);}}QCloudCOSXMLService.defaultCOSXML().getBucket(getBucketReq);
查询对象历史版本列表
功能说明
查询开启版本控制的存储桶下的部分或者全部对象。
使用案例
获取对象历史版本列表第一页数据
QCloudListObjectVersionsRequest* listObjectVersionsRequest = [[QCloudListObjectVersionsRequest alloc] init];// 存储桶名称listObjectVersionsRequest.bucket = @"bucketname";// 一页请求数据条目数，默认 1000listObjectVersionsRequest.maxKeys = 100;//从当前key列出剩余的条目listObjectVersionsRequest.keyMarker = prevPageResult.nextKeyMarker;//从当前key的某个版本列出剩余的条目listObjectVersionsRequest.versionIdMarker = prevPageResult.nextVersionIDMarkder;[listObjectVersionsRequest setFinishBlock:^(QCloudListVersionsResult * _Nonnull result,NSError * _Nonnull error) {// 已删除的文件NSArray<QCloudDeleteMarker*> *deleteMarker = result.deleteMarker;// 对象版本条目NSArray<QCloudVersionContent*> *versionContent = result.versionContent;if (result.isTruncated) {// 表示数据被截断，需要拉取下一页数据self->prevPageResult = result;}}];[[QCloudCOSXMLService defaultCOSXML] ListObjectVersions:listObjectVersionsRequest];
SDK API 参考
API 操作
关于列出对象的 API 接口说明，请参见 List Objects 文档。
关于列出对象历史版本的 API 接口说明，请参见 List Object versions 文档。
