Configuring a Bucket Inventory Rule

Function

The bucket inventory function periodically generates a list of object metadata information for a bucket, helping you better understand object statuses in the bucket. The bucket owner or users who have the required permission can call this API to configure an inventory rule for a bucket. A maximum of 10 inventory rules can be configured for each bucket. For more information and constraints about bucket inventories, see Bucket Inventories.

To perform this operation, you must have the PutBucketInventoryConfiguration permission. By default, the bucket owner has this permission and can grant it to others.

For fusion buckets, inventory rules can be configured for an active bucket, but cannot be configured for a standby bucket.

Restrictions

Authorization Information

To call this API, you must be the bucket owner or have the permissions to configure bucket inventory rules. You are advised to use IAM or bucket policies for authorization. For details about OBS authorization methods, see Differences Between OBS Permissions Control Methods.

• If you use IAM for authorization, you need to use either role/policy-based authorization or identity policy-based authorization and configure the required permission:
  • If you use role/policy-based authorization (IAM v3 APIs in the old IAM version), the obs:bucket:PutBucketInventoryConfiguration permission is required. For details, see Creating a Custom IAM Policy.
  • If you use identity policy-based authorization (IAM v5 APIs in the new IAM version), as shown in the following table, the obs:bucket:putBucketInventoryConfiguration permission is required. For details, see Creating a Custom IAM Identity Policy.

    Action	Access Level	Resource Type (*: required)	Condition Key	AliasAlias	Dependency
    obs:bucket:putBucketInventoryConfiguration	Write	bucket *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-
    		-	obs:EpochTime obs:SourceIp obs:TlsVersion obs:CustomDomain

• If you use bucket policies for authorization, the obs:bucket:PutBucketInventoryConfiguration permission is required. For details, see Creating a Custom Bucket Policy.

Method

func (obsClient ObsClient) SetBucketInventory(input *SetBucketInventoryInput, extensions ...extensionOptions) (output *BaseModel, err error)

Request Parameters

Sample Code

This example configures an inventory rule with ID inventory-rule-1 for bucket examplebucket.

package main

import (
	"fmt"
	"log"

        obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)

func main() {
    // Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
        ak := os.Getenv("AccessKeyID")
        sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    securityToken := os.Getenv("SecurityToken")


    // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"




	// Create a client.
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }

	// Configure an inventory rule.
	input := &obs.SetBucketInventoryInput{
		Bucket: "my-bucket",
		InventoryConfiguration: obs.InventoryConfiguration{
			Id:        "inventory-rule-1",
			IsEnabled: true,
			Destination: obs.InventoryDestination{
				Format: "CSV",
				Bucket: "report-bucket",
				Prefix: "inventory-reports/",
			},
			Schedule: obs.InventorySchedule{
				Frequency: "Daily", // Inventories are generated once a day.
			},
			IncludedObjectVersions: "All", // All object versions are included.
			OptionalFields: &obs.InventoryOptionalFields{
				Fields: []string{
					"Size",
					"LastModifiedDate",
					"StorageClass",
					"ETag",
					"IsMultipartUploaded",
				},
			},
		},
	}

	output, err := client.SetBucketInventory(input)
	if err != nil {
		log.Fatalf("Failed to set bucket inventory: %v", err)
	}

	fmt.Printf("Request ID: %s\n", output.RequestId)
	fmt.Println("Inventory configuration set successfully")
}

Helpful Links

• Bucket Inventory Sample Code on GitHub
• OBS Error Codes