Inventory

Note

This document provides an overview of inventory's API and SDK sample code.

Set up inventory job

Function description

PUT Bucket inventory is used to create inventory and job in Bucket.

Method prototype

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

Request Sample

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 common special errors that may occur in this request are as follows:

Inquire about inventory job

Function description

GET Bucket inventory is used to query inventory and job information of users in Bucket.

Method prototype

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

Request Sample

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

Return result description

type BucketGetInventoryResult BucketPutInventoryOptions

Inquire about all inventory

Function description

List Bucket Inventory Configurations requests all inventory tasks in a bucket. Up to 1,000 inventory tasks can be configured in one bucket.

Method prototype

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

Request Sample

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

Return result description

type BucketListInventoryConfiguartion BucketPutInventoryOptions

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

Delete inventory job

Function description

DELETE Bucket inventory is used to delete inventory and job specified in Bucket.

Method prototype

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

Request Sample

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

Parameter description