tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

列出对象

PDF
聚焦模式
字号
最后更新时间: 2024-01-05 16:09:42

简介

本文档提供关于列出对象操作相关的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
查询对象列表
查询存储桶下的部分或者全部对象

查询对象列表

功能说明

查询存储桶下的部分或者全部对象。

示例代码一: 获取第一页数据

// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucket
String bucket = "examplebucket-1250000000";
try {
BucketContents bucketContents = await Cos().getDefaultService().getBucket(
bucket,
prefix: "dir/", // 前缀匹配,用来规定返回的对象前缀地址
maxKeys: 100 // 单次返回最大的条目数量,默认1000
);
// 表示数据被截断,需要拉取下一页数据
var isTruncated = bucketContents.isTruncated;
// nextMarker 表示下一页的起始位置
var nextMarker = bucketContents.nextMarker;
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
print(e);
}

示例代码二:请求下一页数据

// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucket
String bucket = "examplebucket-1250000000";
// prevPageBucketContents 是上一页的返回结果,这里的 nextMarker 表示下一页的起始位置
String prevPageMarker = prevPageBucketContents.nextMarker;
try {
BucketContents bucketContents = await Cos().getDefaultService().getBucket(
bucket,
prefix: "dir/", // 前缀匹配,用来规定返回的对象前缀地址
marker: prevPageMarker, // 起始位置
maxKeys: 100 // 单次返回最大的条目数量,默认1000
);
// 表示数据被截断,需要拉取下一页数据
var isTruncated = bucketContents.isTruncated;
// nextMarker 表示下一页的起始位置
var nextMarker = bucketContents.nextMarker;
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
print(e);
}

示例代码三:获取对象列表与子目录

// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucket
String bucket = "examplebucket-1250000000";
// 定界符为一个符号,如果有 Prefix,
// 则将 Prefix 到 delimiter 之间的相同路径归为一类,定义为 Common Prefix,
// 然后列出所有 Common Prefix。如果没有 Prefix,则从路径起点开始
var delimiter = "/";
try {
BucketContents bucketContents = await Cos().getDefaultService().getBucket(
bucket,
prefix: "dir/", // 前缀匹配,用来规定返回的对象前缀地址
delimiter: delimiter,
maxKeys: 100 // 单次返回最大的条目数量,默认1000
);
// 表示数据被截断,需要拉取下一页数据
var isTruncated = bucketContents.isTruncated;
// nextMarker 表示下一页的起始位置
var nextMarker = bucketContents.nextMarker;
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
print(e);
}

参数说明

参数名称
描述
类型
是否必选
bucket
桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
prefix
对象键匹配前缀,限定响应中只包含指定前缀的对象键
String
delimiter
一个字符的分隔符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中,具体场景和用法可参考上面的实际案例
String
encodingType
规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91
String
marker
起始对象键标记,从该标记之后(不含)按照 UTF-8 字典序返回对象键条目
String
maxKeys
单次返回最大的条目数量,默认值为1000,最大为1000 注意:该参数会限制每一次 List 操作返回的最大条目数,COS 在每次 List 操作中将返回不超过 max-keys 所设定数值的条目(即 CommonPrefixes 和 Contents 的总和),如果单次响应中未列出所有对象,COS 会返回 NextMarker 节点,其值作为您下次 List 请求的 marker 参数,以便您列出后续对象
Int

返回结果说明

成功:返回 BucketContents 包含:对象列表和列表信息。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientException 或者 CosXmlServiceException。详情请参见 异常处理
BucketContents 响应包体具体数据内容如下:
参数名称
描述
类型
name
存储桶的名称,格式为<BucketName-APPID>,例如 examplebucket-1250000000
String
encodingType
编码格式,对应请求中的 encodingType 参数,且仅当请求中指定了 encodingType 参数才会返回该节点
String
prefix
对象键匹配前缀,对应请求中的 prefix 参数
String
marker
起始对象键标记,从该标记之后(不含)按照 UTF-8 字典序返回对象键条目,对应请求中的 marker 参数
String
maxKeys
单次响应返回结果的最大条目数量,对应请求中的 maxKeys 参数
Int
delimiter
分隔符,对应请求中的 delimiter 参数,且仅当请求中指定了 delimiter 参数才会返回该节点
String
isTruncated
响应条目是否被截断,布尔值,例如 true 或 false
Bool
nextMarker
仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入
String
contentsList
对象条目
List<Content>
commonPrefixesList
从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点
List<CommonPrefixes>
对象(Content)中包含如下内容:
参数名称
描述
类型
key
对象键
String
lastModified
对象最后修改时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z
String
eTag
对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如 “8e0b617ca298a564c3331da28dcb50df”,此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同
String
size
对象大小,单位为 Byte
Int
owner
对象持有者信息
Owner
storageClass
对象存储类型。枚举值请参见 存储类型 文档,例如 STANDARD_IA,ARCHIVE
String
持有者信息(Owner) 中包含如下内容:
参数名称
描述
类型
id
对象持有者的 APPID
String
disPlayName
对象持有者的名称
String
CommonPrefixes 中包含如下内容:
参数名称
描述
类型
prefix
单条 Common Prefix 的前缀
String

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈