存储桶操作

最近更新时间:2024-12-02 16:14:22

我的收藏

简介

本文介绍对象存储 COS 通过 React Native SDK 实现查询存储桶列表、创建存储桶、检索存储桶、删除存储桶的示例代码和描述。

注意事项

在您使用存储桶相关操作之前,需要先具有相关权限,具体而言:
若想查询存储桶列表,在您进行 授权策略 时,action 需要设置为 cos:GetService ,更多授权请参见 支持 CAM 的业务接口
若想创建存储桶,在您进行 授权策略 时,action 需要设置为 cos:PutBucket ,更多授权请参见 支持 CAM 的业务接口
若想检索存储桶,在您进行 授权策略 时,action 需要设置为 cos:HeadBucket ,更多授权请参见 支持 CAM 的业务接口
若想删除存储桶,在您进行 授权策略 时,action 需要设置为 cos:DeleteBucket ,更多授权请参见 支持 CAM 的业务接口

相关示例

功能名称
描述
示例代码
查询存储桶列表
查询指定账号下所有的存储桶列表
创建存储桶
在指定账号下创建一个存储桶
检索存储桶
判断某个存储桶是否存在
删除存储桶
删除指定账号下的空存储桶

前期准备

注册 COS 服务

调用 COS 的接口之前,必须先注册 COS 服务,详细代码请参见 注册 COS 服务

查询存储桶列表

用于查询指定账号下所有存储桶列表。
try {
let listAllMyBuckets: ListAllMyBuckets = await Cos.getDefaultService().getService();
// 存储桶列表详情请查看 ListAllMyBuckets 类
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
console.log(e);
}

参数说明

无。

返回结果说明

成功:返回 ListAllMyBuckets 包含:存储桶列表和存储桶持有者信息。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理
ListAllMyBuckets 响应包体具体数据内容如下:
参数名称
描述
类型
buckets
存储桶列表
List<Bucket>
owner
存储桶持有者信息
Owner
存储桶(Bucket)中包含如下内容:
参数名称
描述
类型
name
存储桶的名称
String
location
存储桶所在地域
String
createDate
存储桶的创建时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z
String
存储桶持有者信息(Owner)中包含如下内容:
参数名称
描述
类型
id
完整 ID
String
disPlayName
存储桶持有者的名字
String

创建存储桶

创建一个存储桶(PUT Bucket)。
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
let bucket = "examplebucket-1250000000";
// 存储桶所在地域简称,例如广州地区是 ap-guangzhou
let region = "COS_REGION";
// 是否开启多 AZ
let enableMAZ = false;
try {
await Cos.getDefaultService().putBucket(
bucket,
{
region: region,
enableMAZ: enableMAZ
}
);
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
console.log(e);
}

参数说明

参数名称
描述
类型
是否必选
bucket
桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
enableMAZ
是否创建多 AZ 存储桶
String

返回结果说明

成功:无返回值。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理

检索存储桶及其权限

HEAD Bucket 请求可以确认该存储桶是否存在,是否有权限访问。有以下几种情况:
存储桶存在且有读取权限,返回 HTTP 状态码为200。
无存储桶读取权限,返回 HTTP 状态码为403。
存储桶不存在,返回 HTTP 状态码为404。
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
let bucket = "examplebucket-1250000000";
// 存储桶所在地域简称,例如广州地区是 ap-guangzhou
let region = "COS_REGION";
try {
let header = await Cos.getDefaultService().headBucket(
bucket,
region
);
// HTTP 状态码为200,HTTP 头为 header
} catch (e) {
// e.statusCode 查看具体的 HTTP 状态码
console.log(e);
}

参数说明

参数名称
描述
类型
bucket
桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String

返回结果说明

成功:返回 HTTP Header。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理

删除存储桶

删除指定的存储桶(DELETE Bucket)。
注意:
删除存储桶前,请确保存储桶内的数据和未完成上传的分块数据已全部清空,否则会无法删除存储桶。
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
let bucket = "examplebucket-1250000000";
// 存储桶所在地域简称,例如广州地区是 ap-guangzhou
let region = "COS_REGION";
try {
await Cos.getDefaultService().deleteBucket(
bucket,
region
);
} catch (e) {
// 失败后会抛异常 根据异常进行业务处理
console.log(e);
}

参数说明

参数名称
描述
类型
bucket
桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String

返回结果说明

成功:无返回值。
失败:发生错误(如身份认证失败),抛出异常 CosXmlClientError 或者 CosXmlServiceError。详情请参见 异常处理

API 操作

关于查询存储桶列表的 API 接口说明,请参见 GET Service (List Buckets) 文档。
关于创建存储桶的 API 接口说明,请参见 PUT Bucket 文档。
关于检索存储桶的 API 接口说明,请参见 HEAD Bucket 文档。
关于删除存储桶的 API 接口说明,请参见 DELETE Bucket 文档。