动态与公告

产品动态

产品公告

产品简介

产品概述

功能概览

应用场景

产品优势

基本概念

地域和访问域名

规格与限制

产品计费

计费概述

计费方式

计费项

免费额度

计费示例

查看和下载账单

欠费说明

常见问题

快速入门

控制台快速入门

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 示例代码。
注意
建议用户 使用临时密钥 调用 SDK，通过临时授权的方式进一步提高 SDK 使用的安全性。申请临时密钥时，请遵循 最小权限指引原则，防止泄漏目标存储桶或对象之外的资源。
如果您一定要使用永久密钥，建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。
API
操作名
操作描述
GET Service
查询存储桶列表
查询指定账号下所有的存储桶列表
PUT Bucket
创建存储桶
在指定账号下创建一个存储桶
HEAD Bucket
检索存储桶及其权限
检索存储桶是否存在且是否有权限访问
DELETE Bucket
删除存储桶
删除指定账号下的空存储桶
查询存储桶列表
功能说明
用于查询指定账号下所有存储桶列表（GET Service）。
方法原型
list_buckets()
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1
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.list_buckets(
)
返回结果说明
查询存储桶列表，类型为 dict。
{
    'Buckets': {
        'Bucket': [
            {
                'Name': 'string',
                'Location': 'string',
                'CreationDate': 'string'
            },
        ],
    },
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    }
}
参数名称
参数描述
类型
Buckets
存储桶列表
Dict
Bucket
存储桶列表
List
Name
存储桶名称
String
Location
存储桶所在的地域名
String
CreationDate
存储桶创建的时间
String
Owner
存储桶所有者信息
Dict
DisplayName
存储桶所有者的名字信息
String
ID
存储桶所有者 ID
String
创建存储桶
功能说明
在指定账号下创建一个存储桶（PUT Bucket）。
方法原型
create_bucket(Bucket, BucketAZConfig=None, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1
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)
﻿
# 存储桶名称不支持大写字母，COS 后端会将用户传入的大写字母自动转换为小写字母用于创建存储桶
response = client.create_bucket(
    Bucket='examplebucket-1250000000'
)
全部参数请求示例
response = client.create_bucket(
    Bucket='examplebucket-1250000000',
    BucketAZConfig='string',
    ACL='private'|'public-read'|'public-read-write',
    GrantFullControl='string',
    GrantRead='string',
    GrantWrite='string'    
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
待创建的存储桶名称，由 BucketName-APPID 构成。
存储桶名称不支持大写字母，COS 后端会将用户传入的大写字母自动转换为小写字母用于创建存储桶
String
是
BucketAZConfig
存储桶 AZ 配置，指定为 'MAZ' 以创建多 AZ 存储桶
String
否
ACL
设置存储桶的 ACL，例如 'private'，'public-read'，'public-read-write'
String
否
GrantFullControl
赋予指定账户对存储桶的读写权限，格式为id="OwnerUin"
String
否
GrantRead
赋予指定账户对存储桶的读权限，格式为id="OwnerUin"
String
否
GrantWrite
赋予指定账户对存储桶的写权限，格式为id="OwnerUin"
String
否
返回结果说明
该方法返回值为 None。
检索存储桶及其权限
功能说明
检索存储桶是否存在且是否有权限访问（HEAD Bucket）。
方法原型
head_bucket(Bucket)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1
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.head_bucket(
    Bucket='examplebucket-1250000000'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
待查询的存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
该方法返回值为 None。
删除存储桶
功能说明
删除指定账号下的空存储桶（DELETE Bucket）。
方法原型
delete_bucket(Bucket)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1
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(
    Bucket='examplebucket-1250000000'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
待删除的存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
该方法返回值为 None。
判断存储桶是否存在
功能说明
判断存储桶是否存在。
方法原型
bucket_exists(Bucket)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1
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.bucket_exists(
    Bucket='examplebucket-1250000000'
)
print(response)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
True 表示存储桶存在，False 表示存储桶不存在。

帮助和支持

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

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

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

文档反馈

tencent cloud

对象存储

存储桶操作

简介

查询存储桶列表

功能说明

方法原型

请求示例

返回结果说明

创建存储桶

功能说明

方法原型

请求示例

全部参数请求示例

参数说明

返回结果说明

检索存储桶及其权限

功能说明

方法原型

请求示例

参数说明

返回结果说明

删除存储桶

功能说明

方法原型

请求示例

参数说明

返回结果说明

判断存储桶是否存在

功能说明

方法原型

请求示例

参数说明

返回结果说明

帮助和支持

API	操作名	操作描述
GET Service	查询存储桶列表	查询指定账号下所有的存储桶列表
PUT Bucket	创建存储桶	在指定账号下创建一个存储桶
HEAD Bucket	检索存储桶及其权限	检索存储桶是否存在且是否有权限访问
DELETE Bucket	删除存储桶	删除指定账号下的空存储桶

参数名称	参数描述	类型
Buckets	存储桶列表	Dict
Bucket	存储桶列表	List
Name	存储桶名称	String
Location	存储桶所在的地域名	String
CreationDate	存储桶创建的时间	String
Owner	存储桶所有者信息	Dict
DisplayName	存储桶所有者的名字信息	String
ID	存储桶所有者 ID	String