Overview

This document provides an overview of APIs and SDK code samples related to inventory.

Setting Inventory Job

Feature description

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

Method prototype

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

Sample request

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: dBucket,
        Format: "CSV",
    },
}
resp, err := client.Bucket.PutInventory(context.Background(), id, opt)

Parameter 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 code description

Some frequent special errors that may occur with this request are listed below:

Querying Inventory Job

Feature description

This API (GET Bucket inventory) is used to query the inventory job information in a bucket.

Method prototype

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

Sample request

v, response, err := client.Bucket.GetInventory(context.Background(), id)

Returned result description

type BucketGetInventoryResult BucketPutInventoryOptions

Querying All Inventories

Feature description

This API (List Bucket Inventory Configurations) is used to request that all inventory jobs in a bucket be returned. Up to 1,000 inventory jobs can be configured in one bucket.

Method prototype

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

Sample request

v, resp, err := client.Bucket.ListInventoryConfigurations(context.Background(), "")

Returned result description

type BucketListInventoryConfiguartion BucketPutInventoryOptions

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

Deleting Inventory Job

Feature description

This API (DELETE Bucket inventory) is used to delete a specified inventory job of a bucket.

Method prototype

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

Sample request

resp, err = client.Bucket.DeleteInventory(context.Background(), "test_id")

Parameter description