tencent cloud

Feature Overview

This document provides an overview of APIs and SDK code samples for COS inventory.

Creating an Inventory Job

Feature description

This API (PUT Bucket inventory) is used to create an inventory job for a bucket.

Method prototype

func (s *BucketService) PutInventory(ctx context.Context, id string, opt *BucketPutInventoryOptions) (*Response, error)

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   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{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/32675.
       },
   })
   opt := &cos.BucketPutInventoryOptions{
       ID: "test_id",
       // True or False
       IsEnabled:              "True",
       IncludedObjectVersions: "All",
       Filter: &cos.BucketInventoryFilter{
           Prefix: "test",
       },
       OptionalFields: &cos.BucketInventoryOptionalFields{
           BucketInventoryFields: []string{
               "Size", "LastModifiedDate",
           },
       },
       Schedule: &cos.BucketInventorySchedule{
           // Weekly or Daily
           Frequency: "Daily",
       },
       Destination: &cos.BucketInventoryDestination{
           Bucket: "dest_bucket-1250000000",
           Format: "CSV",
       },
   }
   _, err := client.Bucket.PutInventory(context.Background(), "test_id", opt)
   if err != nil{
       // ERROR
   }
}

Field description

type BucketInventoryFilter struct {
  Prefix     string 
}
type BucketInventoryOptionalFields struct {
  BucketInventoryFields []string 
}
type BucketInventorySchedule struct {
  Frequency string 
}
type BucketInventoryEncryption struct {
  SSECOS string 
}
type BucketInventoryDestination struct {
  Bucket     string                     
  AccountId  string                     
  Prefix     string                    
  Format     string
  Encryption *BucketInventoryEncryption 
}
// BucketPutInventoryOptions ...
type BucketPutInventoryOptions struct {
  XMLName                xml.Name                     
  ID                     string                         
  IsEnabled              string                       
  IncludedObjectVersions string                      
  Filter                 *BucketInventoryFilter        
  OptionalFields         *BucketInventoryOptionalFields 
  Schedule               *BucketInventorySchedule      
  Destination            *BucketInventoryDestination
}

Error codes

The following describes some common errors that may occur when you call this API:

Querying Inventory Jobs

Feature description

This API is used to query the inventory jobs of a bucket.

Method prototype

func (s *BucketService) GetInventory(ctx context.Context, id string) (*BucketGetInventoryResult, *Response, error)

Sample request

package main
import (
   "context"
   "fmt"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   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{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/32675.
       },
   })
   v, _, err := client.Bucket.GetInventory(context.Background(), "test_id")
   if err != nil{
       // ERROR
   }
   fmt.Println(v)
}

Response description

type BucketGetInventoryResult BucketPutInventoryOptions

Querying All Inventories

Feature description

This API is used to query all inventory jobs configured for a bucket. You can configure up to 1,000 inventory jobs for a bucket.

Method prototype

func (s *BucketService) ListInventoryConfigurations(ctx context.Context, token string) (*ListBucketInventoryConfigResult, *Response, error)

Sample request

package main
import (
   "context"
   "fmt"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, see https://www.tencentcloud.com/document/product/436/6224.
   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{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/32675.
       },
   })
   v, _, err := client.Bucket.ListInventoryConfigurations(context.Background(), "")
   if err != nil{
       // ERROR
   }
   fmt.Println(v)
}

Response description

type BucketListInventoryConfiguartion BucketPutInventoryOptions
type ListBucketInventoryConfigResult struct {
  XMLName                 xml.Name          
  InventoryConfigurations []BucketListInventoryConfiguartion 
  IsTruncated             bool   
  ContinuationToken       string    
  NextContinuationToken   string
}

Deleting an Inventory Job

Feature description

This API is used to delete a specified inventory job from a bucket.

Method prototype

func (s *BucketService) DeleteInventory(ctx context.Context, id string) (*Response, error)

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   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{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/32675.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/32675.
       },
   })
   _, err := client.Bucket.DeleteInventory(context.Background(), "test_id")
   if err != nil{
       // ERROR
   }
}

Field description