Listing Bucket Inventory Rules

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. You can call this API to list all inventory rules of a bucket. All inventory rules are returned at a time without pagination.

To perform this operation, you must have the GetBucketInventoryConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.

For more information about permission control, see the permission control in the OBS Permission Configuration Guide.

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

Restrictions

• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

• Before calling APIs related to bucket inventories, you need to call obs.WithSignature(obs.SignatureObs) to specify the protocol type when initializing the obsClient.

Method

func (obsClient ObsClient) ListBucketInventory(bucketName string, extensions ...extensionOptions) (output *ListBucketInventoryOutput, err error)

Request Parameters

Response Parameter Description

Sample Code

This example lists all inventory rules configured 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())
    }
	// List all inventory rules.
	output, err := client.ListBucketInventory("my-bucket")
	if err != nil {
		log.Fatalf("Failed to list bucket inventory: %v", err)
	}

	fmt.Printf("Request ID: %s\n", output.RequestId)
	fmt.Printf("Total configurations: %d\n", len(output.InventoryConfigurations))

	for i, config := range output.InventoryConfigurations {
		fmt.Printf("\n[%d] Inventory Configuration:\n", i+1)
		fmt.Printf("  ID: %s\n", config.Id)
		fmt.Printf("  Enabled: %v\n", config.IsEnabled)
		fmt.Printf("  Frequency: %s\n", config.Schedule.Frequency)
		fmt.Printf("  Format: %s\n", config.Destination.Format)
		fmt.Printf("  Destination: %s/%s\n", config.Destination.Bucket, config.Destination.Prefix)

		if config.Filter != nil {
			fmt.Printf("  Filter Prefix: %s\n", config.Filter.Prefix)
		}

		fmt.Printf("  Included Versions: %s\n", config.IncludedObjectVersions)

		if config.OptionalFields != nil {
			fmt.Printf("  Optional Fields: %v\n", config.OptionalFields.Fields)
		}
	}

	if output.IsTruncated {
		fmt.Printf("\nNote: Results truncated. NextId: %s\n", output.NextId)
	}
}

Helpful Links

• (GitHub) Sample Code for Listing Inventory Rules of a Bucket
• OBS Error Codes