动态与公告

产品动态

产品公告

产品简介

产品概述

功能概览

应用场景

产品优势

基本概念

地域和访问域名

规格与限制

产品计费

计费概述

计费方式

计费项

免费额度

计费示例

查看和下载账单

欠费说明

常见问题

快速入门

控制台快速入门

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:43:35

简介
本文档提供关于清单的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
PUT Bucket inventory
设置清单任务
设置存储桶的清单任务
GET Bucket inventory
查询清单任务
查询存储桶的清单任务
DELETE Bucket inventory
删除清单任务
删除存储桶的清单任务
设置清单任务
功能说明
PUT Bucket inventory 用于在存储桶中创建清单任务。
方法原型
put_bucket_inventory(Bucket, Id, InventoryConfiguration={}, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.put_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string',
    InventoryConfiguration={
        'Destination': {
            'COSBucketDestination': {
                'AccountId': '100000000001',
                'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
                'Format': 'CSV',
                'Prefix': 'string',
                'Encryption': {
                    'SSECOS': {}
                }
            }
        },
        'IsEnabled': 'true'|'false',
        'Filter': {
            'Prefix': 'string'
        },
        'IncludedObjectVersions':'All'|'Current',
        'OptionalFields': {
            'Field': [
                'Size',
                'LastModifiedDate',
                'ETag',
                'StorageClass',
                'IsMultipartUploaded',
                'ReplicationStatus'
            ]
        },
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    }
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
设置清单任务的存储桶，格式为 BucketName-APPID ，详情请参见 命名规范
String
是
Id
清单任务的名称，合法字符：a-z，A-Z，0-9，-，_，.
String
是
Destination
清单任务投递的目的信息
Dict
是
COSBucketDestination
清单任务结果投递的目的存储桶信息
Dict
是
AccountId
目的存储桶的账号信息
String
否
Bucket
目的存储桶的名称
String
是
Format
清单结果文件的格式，可选值 CSV
String
是
Prefix
目的存储桶投递路径的前缀
String
否
Encryption
目的存储桶投递文件的加密信息，可选值 SSECOS
Dict
否
IsEnabled
清单任务是否启用的标识，可选值 true、flase
String
是
Filter
清单分析对象的过滤条件
Dict
否
Prefix
清单分析对象的过滤前缀
String
否
IncludedObjectVersions
包含多版本的情况，可选值 All、Current
String
是
OptionalFields
清单可选的字段
Dict
否
Field
字段名，包括 Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、ReplicationStatus
List
否
Schedule
清单任务执行的计划
Dict
是
Frequency
清单任务执行的频率，可选值 Daily、Weekly
String
是
返回结果说明
该方法返回值为 None。
错误码说明
该请求可能会发生的一些常见的特殊错误如下：
错误码
描述
状态码
InvalidArgument
不合法的参数值
HTTP 400 Bad Request
TooManyConfigurations
清单数量已经达到1000条的上限
HTTP 400 Bad Request
AccessDenied
未授权的访问。您可能不具备访问该存储桶的权限
HTTP 403 Forbidden
查询清单任务
功能说明
GET Bucket inventory 用于查询存储桶中用户的清单任务信息。
方法原型
get_bucket_inventory(Bucket, Id, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.get_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
查询清单任务的存储桶，格式为 BucketName-APPID ，详情请参见 命名规范
String
是
Id
清单任务的名称，合法字符：a-z，A-Z，0-9，-，_，.
String
是
返回结果说明
Bucket 清单任务配置，类型为 dict。
{
    'Id': 'string',
    'Destination': {
        'COSBucketDestination': {
            'AccountId': '100000000001',
            'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
            'Format': 'CSV',
            'Prefix': 'string',
            'Encryption': {
                'SSECOS': {}
            }
        }
    },
    'IsEnabled': 'true'|'false',
    'Filter': {
        'Prefix': 'string'
    },
    'IncludedObjectVersions':'All'|'Current',
    'OptionalFields': {
        'Field': [
            'Size',
            'LastModifiedDate',
            'ETag',
            'StorageClass',
            'IsMultipartUploaded',
            'ReplicationStatus'
        ]
    },
    'Schedule': {
        'Frequency': 'Daily'|'Weekly'
    }
}
参数名称
参数描述
类型
Id
清单任务的名称，合法字符：a-z，A-Z，0-9，-，_，.
String
Destination
清单任务投递的目的信息
Dict
COSBucketDestination
清单任务结果投递的目的存储桶信息
Dict
AccountId
目的存储桶的账号信息
String
Bucket
目标存储桶的名称
String
Format
清单结果文件的格式，可选值 CSV
String
Prefix
目的存储桶投递路径的前缀
String
Encryption
目的存储桶投递文件的加密信息，可选值 SSECOS
Dict
IsEnabled
清单任务是否启用的标识，可选值 true、flase
String
Filter
清单分析对象的过滤条件
Dict
Prefix
清单分析对象的过滤前缀
String
IncludedObjectVersions
包含多版本的情况，可选值 All、Current
String
OptionalFields
清单可选的字段
Dict
Field
字段名，包括 Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、ReplicationStatus
List
Schedule
清单任务执行的计划
Dict
Frequency
清单任务执行的频率，可选值 Daily、Weekly
String
删除清单任务
功能说明
DELETE Bucket inventory 用于删除存储桶中指定的清单任务。
方法原型
delete_bucket_inventory(Bucket, Id, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.delete_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
被删除清单任务的存储桶，格式为 BucketName-APPID ，详情请参见 命名规范
String
是
Id
清单任务的名称，合法字符：a-z，A-Z，0-9，-，_，.
String
是
返回结果说明
该方法返回值为 None。

帮助和支持

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

您也可以联系销售或提交工单以寻求帮助。

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

文档反馈

tencent cloud

对象存储

清单

简介

设置清单任务

功能说明

方法原型

请求示例

参数说明

返回结果说明

错误码说明

查询清单任务

功能说明

方法原型

请求示例

参数说明

返回结果说明

删除清单任务

功能说明

方法原型

请求示例

参数说明

返回结果说明

帮助和支持

API	操作名	操作描述
PUT Bucket inventory	设置清单任务	设置存储桶的清单任务
GET Bucket inventory	查询清单任务	查询存储桶的清单任务
DELETE Bucket inventory	删除清单任务	删除存储桶的清单任务

参数名称	参数描述	类型	是否必填
Bucket	设置清单任务的存储桶，格式为 BucketName-APPID ，详情请参见命名规范	String	是
Id	清单任务的名称，合法字符：a-z，A-Z，0-9，-，_，.	String	是
Destination	清单任务投递的目的信息	Dict	是
COSBucketDestination	清单任务结果投递的目的存储桶信息	Dict	是
AccountId	目的存储桶的账号信息	String	否
Bucket	目的存储桶的名称	String	是
Format	清单结果文件的格式，可选值 CSV	String	是
Prefix	目的存储桶投递路径的前缀	String	否
Encryption	目的存储桶投递文件的加密信息，可选值 SSECOS	Dict	否
IsEnabled	清单任务是否启用的标识，可选值 true、flase	String	是
Filter	清单分析对象的过滤条件	Dict	否
Prefix	清单分析对象的过滤前缀	String	否
IncludedObjectVersions	包含多版本的情况，可选值 All、Current	String	是
OptionalFields	清单可选的字段	Dict	否
Field	字段名，包括 Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、ReplicationStatus	List	否
Schedule	清单任务执行的计划	Dict	是
Frequency	清单任务执行的频率，可选值 Daily、Weekly	String	是

错误码	描述	状态码
InvalidArgument	不合法的参数值	HTTP 400 Bad Request
TooManyConfigurations	清单数量已经达到1000条的上限	HTTP 400 Bad Request
AccessDenied	未授权的访问。您可能不具备访问该存储桶的权限	HTTP 403 Forbidden