详情页标题前

腾讯云对象存储列出对象

详情页1

简介

文档提供关于列出对象操作相关的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
GET Bucket(List Objects) 查询对象列表 查询存储桶下的部分或者全部对象

查询对象列表

功能说明

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

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

// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucketString 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.cloud.tencent.com/cos5/bucketString 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.cloud.tencent.com/cos5/bucketString 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 存储桶的名称,格式为,例如 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
commonPrefixesList 从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点。 List

对象(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



对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠

转转请注明出处:https://www.yunxiaoer.com/145567.html

(0)
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

相关推荐

  • 阿里云日志服务SLS对接JDBC-云淘科技

    本文以实际案例演示如何使用JDBC连接日志服务、读取日志数据,及使用MySQL协议和SQL语法来计算日志。 前提条件 已创建RAM用户并完成授权。具体操作,请参见创建RAM用户并完成授权。 已配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见配置环境变量。 重要…

    阿里云日志服务SLS 2023年12月10日
  • 腾讯云内容分发网络CDN定时刷新预热

    定时刷新预热通过腾讯云 SCF 云函数,设置定时触发的刷新/预热任务。定时刷新预热任务被包括在每日刷新/预热的配额之内,执行当天如超过当日配额可能导致任务失败。 配置说明 登录 CDN 控制台,在菜单栏里选择插件中心,单击定时刷新预热插件功能卡片,开通定时刷新预热,即可进入任务配置页面。首次开通之后,也可以单击卡片底部的基础配置进入定时刷新预热的任务列表页面…

    2023年12月9日
  • 腾讯云云点播预设策略

    注意:本文档主要介绍云点播访问管理功能的相关内容,其他产品访问管理相关内容请参见 支持 CAM 的产品。访问管理实质上是将子账号与策略进行绑定,或者说将策略授予子账号。开发者可以在控制台上直接使用预设策略来实现一些简单的授权操作,复杂的授权操作请参见 自定义策略。云点播目前提供了以下预设策略: 策略名称 策略描述 QcloudVODFullAccess 云点…

    2023年12月9日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 阿里云容器服务ACKService FAQ-云淘科技

    本文汇总了使用容器服务ACK Service时的常见问题。 索引 SLB相关 创建Service时,Local和Cluster两种外部流量策略如何选择? 为什么看不到Service与LoadBalancer同步过程的事件Event信息? SLB创建一直处于Pending状态如何处理? SLB虚拟服务器组未更新如何处理? Service注解不生效如何处理? 为…

    2023年12月10日
  • dataworks支持maxcompute的数据同步到mysql的分表吗?-云小二-阿里云

    dataworks支持maxcompute的数据同步到mysql的分表吗? 以下为热心网友提供的参考意见 阿里云DataWorks支持将MaxCompute中的数据同步到MySQL的分表。在DataWorks中创建数据同步任务时,可以配置源端为MaxCompute的数据表,目标端为MySQL数据库,并且可以指定目标MySQL表是分表。 具体操作步骤包括: 创…

    阿里云 2023年12月31日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。