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
操作名
操作描述
设置清单任务
设置存储桶的清单任务
查询清单任务
查询存储桶的清单任务
删除清单任务
删除存储桶的清单任务

设置清单任务

功能说明

PUT Bucket inventory 用于在存储桶中创建清单任务。

方法原型

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

请求示例

try {
$result = $cosClient->putBucketInventory(array(
'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
'Id' => 'string',
'Destination' => array(
'COSBucketDestination'=>array(
'Format' => 'CSV',
'AccountId' => '100000000001',
'Bucket' => 'qcs::cos:ap-chengdu::examplebucket-1250000000',
'Prefix' => 'string',
)
),
'IsEnabled' => 'True',
'Schedule' => array(
'Frequency' => 'Daily',
),
'Filter' => array(
'Prefix' => 'string',
),
'IncludedObjectVersions' => 'Current',
'OptionalFields' => array(
'Size',
'ETag',
)
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo "$e\\n";
}


参数说明

参数名称
父节点
描述
类型
是否必选
Bucket
设置清单任务的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
String、Array
Id
清单的名称,与请求参数中的 id 对应
Array
IsEnabled
清单是否启用的标识:
如果设置为 true,清单功能将生效
如果设置为 false,将不生成任何清单
String
IncludedObjectVersions
是否在清单中包含对象版本:
如果设置为 All,清单中将会包含所有对象版本,并在清单中增加 VersionId,IsLatest,DeleteMarker 这几个字段
如果设置为 Current,则清单中不包含对象版本信息
String
Filter
筛选待分析对象。清单功能将分析符合 Filter 中设置的前缀的对象
Array
Prefix
Filter
需要分析的对象的前缀
String
OptionalFields
清单结果中可选包含的分析项目名称,可选字段包括:Size,LastModifiedDate,StorageClass,ETag,IsMultipartUploaded,ReplicationStatus
Array
Schedule
配置清单任务周期
Array
Frequency
Schedule
清单任务周期,可选项为按日或者按周,枚举值:Daily、Weekly
String
Destination
描述存放清单结果的信息
Array
COSBucketDestination
Destination
清单结果导出后存放的存储桶信息
Array
Bucket
COSBucketDestination
清单分析结果的存储桶名
String
AccountId
COSBucketDestination
存储桶的所有者 UIN,例如100000000001
String
Prefix
COSBucketDestination
清单分析结果的前缀
String
Format
COSBucketDestination
清单分析结果的文件形式,可选项为 CSV 格式
String
Encryption
COSBucketDestination
为清单结果提供服务端加密的选项
Array
SSE-COS
Encryption
COS 托管密钥的加密方式,无需填充
String
其他清单配置参数请参考API文档。

错误码说明

该请求可能会发生的一些常见的特殊错误如下:
错误码
描述
状态码
InvalidArgument
不合法的参数值
HTTP 400 Bad Request
TooManyConfigurations
清单数量已经达到1000条的上限
HTTP 400 Bad Request
AccessDenied
未授权的访问。您可能不具备访问该存储桶的权限
HTTP 403 Forbidden

查询清单任务

功能说明

GET Bucket inventory 接口用于查询存储桶中用户的清单任务信息。

方法原型

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


请求示例

try {
$result = $cosClient->getBucketInvnetory(array(
'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
'Id' => 'string',
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo($e);
}


参数说明

参数名称
描述
类型
bucket
查询清单任务的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
bucket
Id
清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
String

返回结果示例

GuzzleHttp\\Command\\Result Object
(
[Destination] => Array
(
[COSBucketDestination] => Array
(
[Format] => CSV
[AccountId] => 100000000001
[Bucket] => qcs::cos:ap-chengdu::examplebucket-1250000000
[Prefix] => String
)

)

[Schedule] => Array
(
[Frequency] => Daily
)

[OptionalFields] => Array
(
[0] => Size
[1] => ETag
)

[IsEnabled] => true
[Id] => string
[IncludedObjectVersions] => Current
[RequestId] => NWRmMzQwMDVfMjNiMjU4NjRfOGQ4MV9iN2Jk****
)

返回结果说明

参数名称
描述
类型
Bucket
存储桶名称格式为 BucketName-APPID ,详情请参见 命名规范
String、Array
Id
清单的名称,与请求参数中的 id 对应
Array
IsEnabled
清单是否启用的标识:
如果设置为 true,清单功能将生效
如果设置为 false,将不生成任何清单
String
IncludedObjectVersions
是否在清单中包含对象版本:
如果设置为 All,清单中将会包含所有对象版本,并在清单中增加 VersionId,IsLatest,DeleteMarker 这几个字段
如果设置为 Current,则清单中不包含对象版本信息
String
Filter
筛选待分析对象。清单功能将分析符合 Filter 中设置的前缀的对象
Array
Prefix
需要分析的对象的前缀
String
OptionalFields
清单结果中可选包含的分析项目名称,可选字段包括:Size,LastModifiedDate,StorageClass,ETag,IsMultipartUploaded,ReplicationStatus
Array
Schedule
配置清单任务周期
Array
Frequency
清单任务周期,可选项为按日或者按周,枚举值:Daily、Weekly
String
Destination
描述存放清单结果的信息
Array
COSBucketDestination
清单结果导出后存放的存储桶信息
Array
Bucket
清单分析结果的存储桶名
String
AccountId
存储桶的所有者 UIN,例如100000000001
String
Prefix
清单分析结果的前缀
String
Format
清单分析结果的文件形式
String
Encryption
为清单结果提供服务端加密的选项
Array
SSE-COS
COS 托管密钥的加密方式,无需填充
String

删除清单任务

功能说明

DELETE Bucket inventory 删除存储桶中指定的清单任务。

方法原型

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

请求示例

try {
$result = $cosClient->deleteBucketInvnetory(array(
'Bucket' => 'examplebucket-1250000000', //格式:BucketName-APPID
'Id' => 'string',
));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo($e);
}


参数说明

参数名称
描述
类型
bucket
存储桶名称的格式为 BucketName-APPID ,详情请参见 命名规范
String
Id
清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
String

帮助和支持

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

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

文档反馈