详情页标题前

腾讯云对象存储列出对象

详情页1

简介

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

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

查询对象列表

功能说明

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

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

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

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

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

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

// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucketlet bucket = "examplebucket-1250000000";// 定界符为一个符号,如果有 Prefix,// 则将 Prefix 到 delimiter 之间的相同路径归为一类,定义为 Common Prefix,// 然后列出所有 Common Prefix。如果没有 Prefix,则从路径起点开始let delimiter = "/";try {  let bucketContents: BucketContents = await Cos.getDefaultService().getBucket(    bucket,    {      prefix: "dir/", // 前缀匹配,用来规定返回的对象前缀地址      delimiter: delimiter,      maxKeys: 100 // 单次返回最大的条目数量,默认1000    }  );  // 表示数据被截断,需要拉取下一页数据  let isTruncated = bucketContents.isTruncated;  // nextMarker 表示下一页的起始位置  let nextMarker = bucketContents.nextMarker;} catch (e) {  // 失败后会抛异常 根据异常进行业务处理  console.log(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 包含:对象列表和列表信息。失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理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/146089.html

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

相关推荐

  • 腾讯云内容分发网络CDNCDN 访问报错423

    现象描述 域名接入 CDN 后,访问返回423状态码和 Forward Loop Detect 报错。 可能原因 源站地址为已接入的 CDN 加速域名,造成了循环解析,无法正常回源。源站配置了 HTTP 请求到 HTTPS 301/302 跳转,且 CDN 控制台开启了回源跟随 301/302 配置,可能会造成访问423。 解决思路 1. 确保您的源站地址与…

    2023年12月9日
  • 本地电脑 如何访问到DMS内网数据库的安全代理地址?-云小二-阿里云

    公司有阿里云vpn 我本地电脑 如何访问到DMS内网数据库的安全代理地址 以下为热心网友提供的参考意见 要访问 DMS 内网数据库的安全代理地址,您需要进行以下步骤: 确定安全代理地址:首先,您需要获得 DMS 的内网数据库的安全代理地址。这通常由 DMS 提供商或系统管理员提供。请与相关人员联系,以获取正确的安全代理地址。 VPN 连接:如果您的本地电脑和…

    阿里云 2023年12月12日
  • 腾讯云对象存储图片二维码

    简介 本文档提供关于对象存储图片二维码相关的 API 概览以及 SDK 示例代码。 API 操作描述 二维码识别 二维码识别功能可识别图片中有效二维码的位置及内容,输出图像中二维码包含的文本信息(每个二维码对应的 URL 或文本),并可对识别出的二维码添加马赛克 图片二维码 上传时识别二维码 功能说明 识别图片中有效二维码的位置及内容,输出图像中二维码包含的…

    腾讯云 2023年12月9日
  • 阿里云负载均衡账单和消费明细查询-云淘科技

    您可以通过查询负载均衡的账单,及时了解其收费明细,更好的从费用分配角度进行业务决策。本文介绍查询账单的操作方法。 操作步骤 登录用户中心的账单详情页面。 在账单详情页面,您可以通过账单流水和明细账单的方式查看账单。 单击账单流水页签,您可以选择账期,输入订单/账单号,单击搜索,系统将显示所有符合条件的账单记录。您可以从产品下拉列表中选择负载均衡,也可以选择产…

    阿里云负载均衡 2023年12月10日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 腾讯云云直播COS bucket 授权给直播实现截图存储

    本文档主要介绍将腾讯云直播截图或鉴黄数据存储至腾讯云对象存储中,以实现通过存储桶(COS Bucket)存储云直播截图或鉴黄数据。首先要创建 COS Bucket ,然后通过 COS Bucket 给云直播授权,最后在直播控制台进行直播截图鉴黄设置,云直播截图或鉴黄数据即可写入指定 COS Bucket(新版控制台功能)。 创建 COS Bucket 1. …

    2023年12月9日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

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

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