Obtaining a Bucket Inventory Rule

Function

OBS uses the GET method to obtain a specific inventory of a bucket. To perform this operation, you must have the GetBucketInventoryConfiguration 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.

Authorization Information

To call this API, you must be the bucket owner or have the permissions to obtain 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:GetBucketInventoryConfiguration 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:getBucketInventoryConfiguration permission is required. For details, see Creating a Custom IAM Identity Policy.

    Action Action	Access Level Access Level	Resource Type (*: required) Resource Type (*: required)	Condition Key Condition Key	AliasAlias Alias	Dependency Dependencies
    obs:bucket:getBucketInventoryConfiguration	Read	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:GetBucketInventoryConfiguration permission is required. For details, see Creating a Custom Bucket Policy.

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) GetBucketInventory(input *GetBucketInventoryInput, extensions ...extensionOptions) (output *GetBucketInventoryOutput, err error)

Request Parameters

Response Parameter Description

Sample Code

This example queries the inventory rule with ID inventory-rule-1 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())
    }

	// Obtain the inventory configuration.
	input := &obs.GetBucketInventoryInput{
		Bucket: "examplebucket",
		Id:     "inventory-rule-1",
	}

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

	fmt.Printf("Request ID: %s\n", output.RequestId)
	fmt.Printf("Inventory ID: %s\n", output.Id)
	fmt.Printf("Enabled: %v\n", output.IsEnabled)
	fmt.Printf("Frequency: %s\n", output.Schedule.Frequency)
	fmt.Printf("Format: %s\n", output.Destination.Format)
	fmt.Printf("Destination Bucket: %s\n", output.Destination.Bucket)
	fmt.Printf("Prefix: %s\n", output.Destination.Prefix)

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

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

Helpful Links

• Bucket Inventory Sample Code on GitHub
• OBS Error Codes