查询存储桶列表

最近更新时间:2025-08-12 15:51:02

我的收藏

简介

本文档提供关于查询存储桶列表的 API 概览以及 SDK 示例代码。

注意事项

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

相关示例

功能名称
描述
示例代码
查询存储桶列表
查询指定账号下所有的存储桶列表

查询存储桶列表

功能说明

查询指定账号下所有的存储桶列表。

方法原型

func (s *ServiceService) Get(ctx context.Context, opt ...*ServiceGetOptions) (*ServiceGetResult, *Response, error)

请求示例

package main

import (
"context"
"fmt"
"github.com/tencentyun/cos-go-sdk-v5"
"net/http"
"net/url"
"os"
)

func main() {
// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
// 替换为用户的 region,存储桶 region 可以在 COS 控制台“存储桶概览”查看 https://console.cloud.tencent.com/ ,关于地域的详情见 https://cloud.tencent.com/document/product/436/6224 。
u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
su, _ := url.Parse("https://service.cos.myqcloud.com")
// 如果只调用GetService接口,只需要配置ServiceURL,SDK内部将ServiceURL已默认配置为https://service.cos.myqcloud.com
b := &cos.BaseURL{BucketURL: u, ServiceURL: su}
client := cos.NewClient(b, &http.Client{
Transport: &cos.AuthorizationTransport{
// 通过环境变量获取密钥
// 环境变量 SECRETID 表示用户的 SecretId,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
SecretID: os.Getenv("SECRETID"), // 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
// 环境变量 SECRETKEY 表示用户的 SecretKey,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
SecretKey: os.Getenv("SECRETKEY"), // 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
},
})
res, _, err := client.Service.Get(context.Background())
if err != nil {
panic(err)
}
for _, bucket := range res.Buckets {
fmt.Printf("%+v\\n", bucket)
}
}

参数说明

type ServiceGetOptions struct {
TagKey string
TagValue string
MaxKeys int64
Marker string
Range string
CreateTime int64
Region string
}
参数名称
参数描述
类型
是否必选
TagKey
支持根据存储桶标签(由标签键 tagkey 和标签值 tagvalue 组成)过滤存储桶,仅支持传入一个存储桶标签,tagkey 用于传入标签键。如需根据存储桶标签查询存储桶,则 tagkey 和 tagvalue 为必填项
string
TagValue
支持根据存储桶标签(由标签键 tagkey 和标签值 tagvalue 组成)过滤存储桶,仅支持传入一个存储桶标签,tagvalue 用于传入标签值。如需根据存储桶标签查询存储桶,则 tagkey 和 tagvalue 为必填项
string
MaxKeys
单次返回最大的条目数量,默认值为2000,最大为2000。如果单次响应中未列出所有存储桶,COS 会返回 NextMarker 节点,其值作为下次 GetService 请求的 marker 参数
int
Marker
起始标记,从该标记之后(不含)按照 UTF-8 字典序返回存储桶条目
string
Range
和 create-time 参数一起使用,支持根据创建时间过滤存储桶,支持枚举值 lt(创建时间早于 create-time)、gt(创建时间晚于 create-time)、lte(创建时间早于或等于 create-time)、gte(创建时间晚于或等于create-time)
string
CreateTime
GMT 时间戳,和 range 参数一起使用,支持根据创建时间过滤存储桶,例如 create-time=1642662645
int
Region
支持根据地域过滤存储桶,例如 region=ap-beijing
string

返回结果说明

通过 GetServiceResult 返回请求结果。
type ServiceGetResult struct {
Owner *Owner
Buckets []Bucket
}
type Owner struct {
ID string
DisplayName string
}
type Bucket struct {
Name string
Region string
CreationDate string
}
参数名称
参数描述
类型
ID
Bucket 所有者的 ID
string
DisplayName
Bucket 所有者的名字信息
string
Name
Bucket 的名称
string
Region
Bucket 所在地域
string
CreationDate
Bucket 创建时间。ISO8601 格式,例如 2016-11-09T08:46:32.000Z
string

API 操作

关于查询存储桶列表的 API 接口说明,请参见 GET Service (List Buckets) 文档。