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-22 11:07:56

简介

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

查询对象列表

功能说明

查询指定存储桶中所有的对象(List Objects)。

方法原型

public Guzzle\\Service\\Resource\\Model listObjects(array $args = array());

请求示例

示例一:查询指定前缀、指定开始对象的对象列表

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //协议头部,默认为http
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->listObjects(array(
'Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
'Delimiter' => '/', //Delimiter表示分隔符, 设置为/表示列出当前目录下的object, 设置为空表示列出所有的object
'EncodingType' => 'url',//编码格式,对应请求中的 encoding-type 参数
'Marker' => 'prefix/picture.jpg',//起始对象键标记
'Prefix' => 'prfix/', //Prefix表示列出的object的key以prefix开始
'MaxKeys' => 1000, // 设置最大遍历出多少个对象, 一次listObjects最大支持1000
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo($e);
}

参数说明

参数名称
类型
描述
是否必填
Bucket
String
存储桶名称,格式:BucketName-APPID
Delimiter
String
默认为空,设置分隔符,例如设置/来模拟文件夹
EncodingType
String
默认不编码,规定返回值的编码方式,可选值:url
Marker
String
默认以 UTF-8 二进制顺序列出条目,标记返回 objects 的 list 的起点位置
Prefix
String
默认为空,对 object 的 key 进行筛选,匹配指定前缀(prefix)的 objects
MaxKeys
Int
最多返回的 objects 数量,默认为最大的1000

返回结果示例

Guzzle\\Service\\Resource\\Model Object
(
[structure:protected] =>
[data:protected] => Array
(
[Name] => examplebucket-1250000000
[Prefix] => doc
[Marker] => doc/picture.jpg
[MaxKeys] => 10
[IsTruncated] => 1
[NextMarker] => doc/exampleobject
[Contents] => Array
(
[0] => Array
(
[Key] => doc/exampleobject
[LastModified] => 2019-02-14T12:20:40.000Z
[ETag] => "e37b429559d82e852af0b2f5b4d078ab72b90208"
[Size] => 6532594
[Owner] => Array
(
[ID] => 100000000001
[DisplayName] => 100000000001
)

[StorageClass] => STANDARD
)

[1] => Array
(
[Key] => doc/exampleobject2
[LastModified] => 2019-03-04T06:34:43.000Z
[ETag] => "988f9f28e68eba9b8c1f5f98ccce0a3c"
[Size] => 28
[Owner] => Array
(
[ID] => 100000000001
[DisplayName] => 100000000001
)

[StorageClass] => STANDARD
)
)
[RequestId] => NWNhMzM0MmZfOWUxYzBiMDlfOTk2YV83ZWE3ODE=
)

)

返回结果说明

参数名称
类型
描述
父节点
Name
String
存储桶名称,格式:BucketName-APPID
Delimiter
String
设置分隔符,例如设置/来模拟文件夹
EncodingType
String
规定返回值的编码方式
Marker
String
默认以 UTF-8 二进制顺序列出条目,标记返回 objects 的 list 的起点位置,通过返回的Key值设为Marker实现翻页
Prefix
String
对 object 的 key 进行筛选,匹配指定前缀(prefix)的 objects
MaxKeys
Int
最多返回的 objects 数量,默认为最大的1000
IsTruncated
Int
表示返回的 objects 否被截断
Contents
Array
返回的对象列表
Content
Array
返回的对象属性,包含所有 objects 元信息的 list,包括 'ETag','StorageClass','Key','Owner','LastModified','Size' 等信息
Contents

查询对象及其历史版本列表

功能说明

查询存储桶下的部分或者全部对象及其历史版本信息。

方法原型

public Guzzle\\Service\\Resource\\Model listObjectVersions(array $args = array());

请求示例

示例一:查询历史对象列表

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'schema' => 'https', //协议头部,默认为http
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));

try {
$result = $cosClient->listObjectVersions(array(
'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
'Delimiter' => '',
'EncodingType' => 'url',
'KeyMarker' => 'doc/picture.jpg',
'VersionIdMarker' => 'MTg0NDUxODMyMTE2ODY0OTExOTk3W',
'Prefix' => 'doc',
'MaxKeys' => 1000,
));
print_r($result);
} catch (\\Exception $e) {
echo($e);
}

参数说明

参数名称
类型
描述
是否必填
Bucket
String
存储桶名称,由 BucketName-APPID 构成
Prefix
String
默认为空,对对象的对象键进行筛选,匹配 prefix 为前缀的对象
Delimiter
String
默认为空,设置分隔符,例如设置/来模拟文件夹
KeyMarker
String
默认以 UTF-8 二进制顺序列出条目,标记返回对象的 list 的 Key 的起点位置
VersionIdMarker
String
默认以 UTF-8 二进制顺序列出条目,标记返回对象的 list 的 VersionId 的起点位置
MaxKeys
Int
最多返回的对象数量,默认为最大的1000
EncodingType
String
默认不编码,规定返回值的编码方式,可选值:url

返回结果示例

Guzzle\\Service\\Resource\\Model Object
(
[structure:protected] =>
[data:protected] => Array
(
[Name] => examplebucket-1250000000
[Prefix] => doc
[KeyMarker] => string
[VersionIdMarker] => string
[MaxKeys] => 10
[IsTruncated] => 1
[NextKeyMarker] => string
[NextVersionIdMarker] => string
[Versions] => Array
(
[0] => Array
(
[Key] => doc/exampleobject1
[VersionId] => null
[IsLatest] => 1
[LastModified] => 2019-06-13T09:24:52.000Z
[ETag] => "96e79218965eb72c92a549dd5a330112"
[Size] => 6
[StorageClass] => STANDARD
[Owner] => Array
(
[UID] => 1250000000
)
)

[1] => Array
(
[Key] => doc/exampleobject2
[VersionId] => MTg0NDUxODMyMTE2ODY0OTExOTk
[IsLatest] => 1
[LastModified] => 2019-06-18T12:47:03.000Z
[ETag] => "698d51a19d8a121ce581499d7b701668"
[Size] => 3
[StorageClass] => STANDARD
[Owner] => Array
(
[UID] => 1250000000
)
)
)
[RequestId] => NWQwOGVkZGRfMjViMjU4NjRfODNjN18xMTE5YWI4
)

)

返回结果说明

参数名称
类型
描述
父节点
Name
String
存储桶名称,格式:BucketName-APPID
Delimiter
String
设置分隔符,例如设置/来模拟文件夹
EncodingType
String
规定返回值的编码方式
KeyMarker
String
默认以 UTF-8 二进制顺序列出条目,标记返回对象的 list 的 Key 的起点位置
VersionIdMarker
String
默认以 UTF-8 二进制顺序列出条目,标记返回对象的 list 的 VersionId 的起点位置
NextKeyMarker
String
当 IsTruncated 为 true 时,标记下一次返回对象的 list 的 Key 的起点位置
NextVersionIdMarker
String
当 IsTruncated 为 true 时,标记下一次返回对象的 list 的 VersionId 的起点位置
Prefix
String
对 object 的 key 进行筛选,匹配指定前缀(prefix)的 objects
MaxKeys
Int
最多返回的 objects 数量,默认为最大的1000
IsTruncated
Int
表示返回的 objects 否被截断
Versions
Array
包含所有多个版本对象元数据的 list
Version
Array
包含所有多个版本对象元数据的 list,包括 'ETag','StorageClass','Key','VersionId','IsLatest','Owner','LastModified','Size' 等信息
Versions
CommonPrefixes
Array
所有以 Prefix 开头,以 Delimiter 结尾的对象被归到同一类


帮助和支持

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

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

文档反馈