tencent cloud

简介

本文档提供关于列出对象操作相关的 API 概览以及 SDK 示例代码。

查询对象列表

功能说明

查询存储桶下的部分或者全部对象。

方法原型

func (s *BucketService) Get(ctx context.Context, opt *BucketGetOptions) (*BucketGetResult, *Response, error)

请求示例1：列出对象列表

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main() {
   // 存储桶名称，由 bucketname-appid 组成，appid 必须填入，可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucket
   // 替换为用户的 region，存储桶 region 可以在 COS 控制台“存储桶概览”查看 https://console.tencentcloud.com/ ，关于地域的详情见 https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1 。
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // 通过环境变量获取密钥
           // 环境变量 SECRETID 表示用户的 SecretId，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
           SecretID: os.Getenv("SECRETID"),  // 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
           // 环境变量 SECRETKEY 表示用户的 SecretKey，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),  // 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
       },
   })
   opt := &cos.BucketGetOptions{
       Prefix:  "test",
       MaxKeys: 100,
   }
   _, _, err := client.Bucket.Get(context.Background(), opt)
   if err != nil {
       panic(err)
   }
}

请求示例2：列出目录下对象

对象存储中本身是没有文件夹和目录的概念的，为了满足用户使用习惯，用户可通过分隔符/来模拟“文件夹”。

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
   "fmt"
)
func main() {
   // 存储桶名称，由 bucketname-appid 组成，appid 必须填入，可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucket
   // 替换为用户的 region，存储桶 region 可以在 COS 控制台“存储桶概览”查看 https://console.tencentcloud.com/ ，关于地域的详情见 https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1 。
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // 通过环境变量获取密钥
           // 环境变量 SECRETID 表示用户的 SecretId，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
           SecretID: os.Getenv("SECRETID"),  // 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
           // 环境变量 SECRETKEY 表示用户的 SecretKey，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),  // 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
       },
   })
   var marker string
   opt := &cos.BucketGetOptions{
       Prefix:    "folder/", // prefix 表示要查询的文件夹
       Delimiter: "/",       // deliter 表示分隔符, 设置为/表示列出当前目录下的 object, 设置为空表示列出所有的 object
       MaxKeys:   1000,      // 设置最大遍历出多少个对象, 一次 listobject 最大支持1000
   }
   isTruncated := true
   for isTruncated {
       opt.Marker = marker
       v, _, err := client.Bucket.Get(context.Background(), opt)
       if err != nil {
           fmt.Println(err)
           break
       }
       for _, content := range v.Contents {
           fmt.Printf("Object: %v\n", content.Key)
       }
       // common prefix 表示表示被 delimiter 截断的路径, 如 delimter 设置为/, common prefix 则表示所有子目录的路径
       for _, commonPrefix := range v.CommonPrefixes {
           fmt.Printf("CommonPrefixes: %v\n", commonPrefix)
       }
       isTruncated = v.IsTruncated // 是否还有数据
       marker = v.NextMarker       // 设置下次请求的起始 key
   }
}

参数说明

type BucketGetOptions struct {
  Prefix       string 
  Delimiter    string 
  EncodingType string 
  Marker       string 
  MaxKeys      int    
}

返回结果说明

type BucketGetResult struct {
  Name           string
  Prefix         string 
  Marker         string 
  NextMarker     string 
  Delimiter      string 
  MaxKeys        int
  IsTruncated    bool
  Contents       []Object 
  CommonPrefixes []string 
  EncodingType   string   
}

查询对象历史版本列表

功能说明

查询开启版本控制的存储桶下的部分或者全部对象。

方法原型

func (s *BucketService) GetObjectVersions(ctx context.Context, opt *BucketGetObjectVersionsOptions) (*BucketGetObjectVersionsResult, *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.tencentcloud.com/cos5/bucket
  // 替换为用户的 region，存储桶 region 可以在 COS 控制台“存储桶概览”查看 https://console.tencentcloud.com/ ，关于地域的详情见 https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1 。
  u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
  b := &cos.BaseURL{BucketURL: u}
  client := cos.NewClient(b, &http.Client{
      Transport: &cos.AuthorizationTransport{
          // 通过环境变量获取密钥
          // 环境变量 SECRETID 表示用户的 SecretId，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
          SecretID: os.Getenv("SECRETID"),  // 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
          // 环境变量 SECRETKEY 表示用户的 SecretKey，登录访问管理控制台查看密钥，https://console.tencentcloud.com/cam/capi
          SecretKey: os.Getenv("SECRETKEY"),  // 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
      },
  })
  keyMarker := ""
  versionIdMarker := ""
  isTruncated := true
  opt := &cos.BucketGetObjectVersionsOptions{}
  for isTruncated {
      opt.KeyMarker = keyMarker
      opt.VersionIdMarker = versionIdMarker
      v, _, err := client.Bucket.GetObjectVersions(context.Background(), opt)
      if err != nil {
          // ERROR
          break
      }
      for _, vc := range v.Version {
          fmt.Printf("Version: %v, %v, %v, %v\n", vc.Key, vc.Size, vc.VersionId, vc.IsLatest)
      }
      for _, dc := range v.DeleteMarker {
          fmt.Printf("DeleteMarker: %v, %v, %v\n", dc.Key, dc.VersionId, dc.IsLatest)
      }
      keyMarker = v.NextKeyMarker
      versionIdMarker = v.NextVersionIdMarker
      isTruncated = v.IsTruncated
  }
}

参数说明

type BucketGetObjectVersionsOptions struct {
   Prefix          string
   Delimiter       string
   EncodingType    string
   KeyMarker       string
   VersionIdMarker string
   MaxKeys         int
}

返回结果说明

type BucketGetObjectVersionsResult struct {
  Name                string
  EncodingType        string
  Prefix              string
  KeyMarker           string
  VersionIdMarker     string
  MaxKeys             int
  Delimiter           string
  IsTruncated         bool
  NextKeyMarker       string
  NextVersionIdMarker string
  CommonPrefixes      []string
  Version             []ListVersionsResultVersion
  DeleteMarker        []ListVersionsResultDeleteMarker
}
type ListVersionsResultVersion struct {
  Key          string
  VersionId    string
  IsLatest     bool
  LastModified string
  ETag         string
  Size         int
  StorageClass string
  Owner        *Owner
}
type ListVersionsResultDeleteMarker struct {
  Key          string
  VersionId    string
  IsLatest     bool
  LastModified string
  Owner        *Owner
}

具体的节点描述如下：

Container 节点 ListVersionsResult 的内容：

Container 节点 CommonPrefixes 的内容：

Container 节点 Version 的内容：

Container 节点 Version.Owner 的内容：

Container 节点 DeleteMarker 的内容：

Container 节点 DeleteMarker.Owner 的内容：