详情页标题前

腾讯云对象存储存储桶操作

详情页1

简介

本文档提供关于存储桶的基本操作和访问控制列表(ACL)的相关 API 概览以及 SDK 示例代码。基本操作

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

访问控制列表

API 操作名 操作描述
PUT Bucket acl 设置存储桶 ACL 设置指定存储桶的访问权限控制列表
GET Bucket acl 查询存储桶 ACL 查询指定存储桶的访问权限控制列表

基本操作

查询存储桶列表

功能说明

GET Service 接口是用来查询请求者名下的所有存储桶列表或特定地域下的存储桶列表(Bucket list)。了解更多请参见 GET Service

使用示例

示例一:列出存储桶列表。

cos.getService(function(err, data) {    console.log(err || data);});

示例二:列出指定地域的存储桶列表。

cos.getService({    Region: 'ap-beijing',}, function(err, data) {    console.log(err || data);});

参数说明

参数名 参数描述 类型 必填
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
– Owner 代表存储桶所有者的对象 Object
– – ID 存储桶持有者的完整 ID,格式为qcs::cam::uin/[OwnerUin]:uin/[OwnerUin],例如 qcs::cam::uin/100000000001:uin/100000000001,其中100000000001为 uin String
– – DisplayName 存储桶持有者的名称 String
– Buckets 存储桶信息列表 Object
– – Name 存储桶的名称,格式为 BucketName-APPID,例如 examplebucket-1250000000 String
– – Location 存储桶所在地域。枚举值请参见 地域和访问域名 文档,例如 ap-guangzhou,ap-beijing,ap-hongkong 等 String
– – CreationDate 存储桶创建时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z String

创建存储桶

功能说明

PUT Bucket 接口请求可以在指定账号下创建一个存储桶。

使用示例

cos.putBucket({    Bucket: 'examplebucket-1250000000',    Region: 'ap-beijing',    ACL: 'private',    // BucketAZConfig: 'MAZ', /* 可选,支持设置存储桶为多az */}, function(err, data) {    console.log(err || data);});

参数说明

参数名 参数描述 类型 必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
ACL 定义存储桶的访问控制列表(ACL)属性。枚举值请参见 ACL 概述 文档中存储桶的预设 ACL 部分,例如 private,public-read 等,默认为 private String
GrantRead 赋予被授权者读取存储桶的权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantWrite 赋予被授权者写入存储桶的权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantReadAcp 赋予被授权者读取存储桶的访问控制列表(ACL)和存储桶策略(Policy)的权限。可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantWriteAcp 赋予被授权者写入存储桶的访问控制列表(ACL)和存储桶策略(Policy)的权限,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantFullControl 赋予被授权者操作存储桶的所有权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
BucketAZConfig 设置存储桶为多az String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object

检索存储桶及其权限

功能说明

HEAD Bucket 请求可以确认该存储桶是否存在,是否有权限访问。有以下几种情况:当该存储桶存在时,返回 HTTP 状态码200。当该存储桶无访问权限时,返回 HTTP 状态码403。当该存储桶不存在时,返回 HTTP 状态码404。

使用示例

检索存储桶信息:

cos.headBucket({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing',     /* 必须 */}, function(err, data) {    console.log(err || data);});

判断存储桶是否存在:

function doesBucketExist() {    cos.headBucket({        Bucket: 'examplebucket-1250000000', /* 必须 */        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */    }, function(err, data) {        if (data) {            console.log('存储桶存在');        } else if (err.statusCode == 404) {            console.log('存储桶不存在');        } else if (err.statusCode == 403) {            console.log('没有该存储桶读权限');        }    });}

参数说明

参数名 参数描述 类型 必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object

删除存储桶

功能说明

删除指定账号下的空存储桶。注意,如果删除成功,则返回的 HTTP 状态码为200或204。说明删除存储桶前,请确保存储桶内的数据和未完成上传的分块数据已全部清空,否则会无法删除存储桶。

使用示例

cos.deleteBucket({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing'     /* 必须 */}, function(err, data) {    console.log(err || data);});

参数说明

参数名 参数描述 类型 必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object

访问控制列表

设置存储桶 ACL

功能说明

PUT Bucket acl 接口用来设置指定存储桶访问权限控制列表(ACL)。

使用示例

设置存储桶公有读:

cos.putBucketAcl({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing',    /* 必须 */    ACL: 'public-read'}, function(err, data) {    console.log(err || data);});

为某个用户赋予存储桶所有权限:

cos.putBucketAcl({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing',    /* 必须 */    GrantFullControl: 'id="qcs::cam::uin/100000000001:uin/100000000001",id="qcs::cam::uin/100000000011:uin/100000000011"' // 100000000001是 uin}, function(err, data) {    console.log(err || data);});

通过 AccessControlPolicy 修改存储桶权限:

cos.putBucketAcl({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing',    /* 必须 */    AccessControlPolicy: {        "Owner": { // AccessControlPolicy 里必须有 owner            "ID": 'qcs::cam::uin/100000000001:uin/100000000001' // 100000000001 是 Bucket 所属用户的 Uin        },        "Grants": [{            "Grantee": {                "ID": "qcs::cam::uin/100000000011:uin/100000000011", // 100000000011 是 Uin            },            "Permission": "WRITE"        }]    }}, function(err, data) {    console.log(err || data);});

参数说明

参数名 参数描述 类型 必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
ACL 定义存储桶的访问控制列表(ACL)属性。枚举值请参见 ACL 概述 文档中存储桶的预设 ACL 部分,例如 private,public-read 等,默认为 private String
GrantRead 赋予被授权者读取存储桶的权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantWrite 赋予被授权者写入存储桶的权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantReadAcp 赋予被授权者读取存储桶的访问控制列表(ACL)和存储桶策略(Policy)的权限。格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantWriteAcp 赋予被授权者写入存储桶的访问控制列表(ACL)和存储桶策略(Policy)的权限。格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
GrantFullControl 赋予被授权者操作存储桶的所有权限,格式:id=”[OwnerUin]”,可使用半角逗号(,)分隔多组被授权者:当需要给子账号授权时,id="qcs::cam::uin/:uin/"当需要给主账号授权时,id="qcs::cam::uin/:uin/"例如'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' String
AccessControlPolicy 跨域资源共享配置的所有信息列表 Object
– Owner 存储桶持有者的信息 Object
– – ID 存储桶持有者的完整 ID,格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin],例如 qcs::cam::uin/100000000001:uin/100000000001,其中100000000001为 uin String
– Grants 被授权者信息与权限信息列表 ObjectArray
– – Permission 授予的权限信息,可选项 READ、WRITE、READ_ACP、WRITE_ACP、FULL_CONTROL。枚举值详情参见 ACL 概述 文档中存储桶的操作部分 String
– – Grantee 被授权者的信息 Object
– – – ID 被授权者的完整 ID,格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin],例如 qcs::cam::uin/100000000001:uin/100000000001,其中100000000001为 uin String
– – – DisplayName 被授权者的名称,一般填写成和 ID 一致的字符串 String
– – – URI 预设用户组,请参见 ACL 概述 文档中预设用户组部分,例如http://cam.qcloud.com/groups/global/AllUsershttp://cam.qcloud.com/groups/global/AuthenticatedUsers String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object

查询存储桶 ACL

功能说明

GET Bucket acl 接口用来查询存储桶的访问控制列表(ACL)。该 API 的请求者需要对存储桶有写入 ACL 权限。

使用示例

cos.getBucketAcl({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'ap-beijing'     /* 必须 */}, function(err, data) {    console.log(err || data);});

返回示例

{    "GrantFullControl": "",    "GrantWrite": "",    "GrantRead": "",    "GrantReadAcp": "id=\"qcs::cam::uin/100000000011:uin/100000000011\"",    "GrantWriteAcp": "id=\"qcs::cam::uin/100000000011:uin/100000000011\"",    "ACL": "private",    "Owner": {        "ID": "qcs::cam::uin/100000000001:uin/100000000001",        "DisplayName": "qcs::cam::uin/100000000001:uin/100000000001"    },    "Grants": [{        "Grantee": {            "ID": "qcs::cam::uin/100000000011:uin/100000000011",            "DisplayName": "qcs::cam::uin/100000000011:uin/100000000011"        },        "Permission": "READ"    }],    "statusCode": 200,    "headers": {}}

参数说明

参数名 参数描述 类型 必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误则为空 Object
– statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
– headers 请求返回的头部信息 Object
– ACL 定义存储桶的访问控制列表(ACL)属性。枚举值请参见 ACL 概述 文档中存储桶的预设 ACL 部分,例如 private, public-read 等,默认为 private String
– GrantRead 具有读取存储桶权限的被授权者 ID 信息 String
– GrantWrite 具有写入存储桶权限的被授权者 ID 信息 String
– GrantReadAcp 具有读取存储桶的访问控制列表(ACL)和存储桶策略(Policy)权限的被授权者 ID 信息 String
– GrantWriteAcp 具有写入存储桶的访问控制列表(ACL)和存储桶策略(Policy)权限的被授权者 ID 信息 String
– GrantFullControl 具有存储桶所有权限的被授权者 ID 信息 String
– Owner 存储桶持有者的信息 Object
– – DisplayName 存储桶持有者的名称 String
– – ID 存储桶持有者的完整 ID格式为qcs::cam::uin/:uin/如果是主账号, 和 是同一个值 String
– Grants 被授权者信息与权限信息列表 ObjectArray
– – Permission 指明授予被授权者的权限信息,枚举值:READ、WRITE、READ_ACP、WRITE_ACP、FULL_CONTROL String
– – Grantee 被授权者的信息 Object
– – – DisplayName 被授权者的名称 String
– – – ID 被授权者的完整 ID:如果是主账号,格式为qcs::cam::uin/:uin/ qcs::cam::anyone:anyone (指代所有用户)如果是子账号,格式为qcs::cam::uin/:uin/ String
– – – URI 预设用户组,请参见 ACL 概述 文档中预设用户组部分,例如http://cam.qcloud.com/groups/global/AllUsershttp://cam.qcloud.com/groups/global/AuthenticatedUsers String



对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠

转转请注明出处:https://www.yunxiaoer.com/146098.html

(0)
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

相关推荐

  • 腾讯云对象存储快速入门

    下载与安装 相关资源 对象存储 COS 的 XML 小程序 SDK 源码下载地址:XML 小程序 SDK。SDK 快速下载地址:XML 小程序 SDK。演示示例 Demo 下载地址:XML 小程序 SDK Demo。SDK 文档中的所有示例代码请参见 SDK 代码示例。SDK 更新日志请参见 ChangeLog。SDK 常见问题请参见:小程序 SDK 常见问…

    腾讯云 2023年12月9日
  • 腾讯云对象存储异常处理

    简介 COS XML Python SDK 操作成功会返回一个 dict 或者 None。若调用 SDK 接口请求 COS 服务失败,系统将抛出 CosClientError(客户端异常)或者 CosServiceError (服务端异常)。CosClientError 是由于客户端无法和 COS 服务端正常进行交互所引起。如客户端无法连接到服务端,无法解析…

    腾讯云 2023年12月9日
  • 腾讯云对象存储生成预签名链接

    简介 小程序 SDK 提供获取对象 URL、获取请求预签名 URL 接口。关于使用预签名 URL 上传的说明请参见 预签名授权上传, 使用预签名 URL 下载的说明请参见 预签名授权下载。说明建议用户使用临时密钥生成预签名,通过临时授权的方式进一步提高预签名上传、下载等请求的安全性。申请临时密钥时,请遵循 最小权限指引原则,防止泄露目标存储桶或对象之外的资源…

    腾讯云 2023年12月9日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 腾讯云对象存储存储桶操作

    简介 本文档提供关于存储桶基本操作的相关 API 概览以及 SDK 示例代码。注意建议用户 使用临时密钥 调用 SDK,通过临时授权的方式进一步提高 SDK 使用的安全性。申请临时密钥时,请遵循 最小权限指引原则,防止泄漏目标存储桶或对象之外的资源。如果您一定要使用永久密钥,建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。 API 操作名 操作描述…

    腾讯云 2023年12月9日
  • 腾讯云对象存储异常处理

    简介 调用 SDK 接口请求 COS 服务失败时,将在回调函数里返回错误信息。 错误处理示例 cos.headBucket({ Bucket: ‘examplebucket-1250000000’, Region: ‘ap-beijing’,}, function(err, data) { if (err) { console.log(err.error);…

    腾讯云 2023年12月9日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。