获取桶清单

功能说明

OBS使用GET操作来获取指定桶的某个清单配置。要正确执行此操作，需要确保执行者拥有GetBucketInventoryConfiguration权限。桶拥有者默认具有此权限，并且可以将此权限授予其他人。

融合桶场景，主桶支持配置桶清单，备桶不支持配置桶清单。

授权信息

您必须是桶拥有者或拥有获取桶清单的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

• 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
  • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:GetBucketInventoryConfiguration权限，授权操作请参见创建IAM自定义策略。
  • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:getBucketInventoryConfiguration权限，授权操作请参见创建IAM自定义身份策略。

    授权项 Action	访问级别 Access Level	资源类型（*为必须） Resource Type (*: required)	条件键 Condition Key	别名别名 Alias	依赖的授权项 Dependencies
    obs:bucket:getBucketInventoryConfiguration	Read	bucket *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-
    		-	obs:EpochTime obs:SourceIp obs:TlsVersion obs:CustomDomain

• 如果使用桶策略进行授权，需具备obs:bucket:GetBucketInventoryConfiguration权限，具体操作请参见自定义创建桶策略。

接口约束

• OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

• 须知：调用桶清单相关接口前，需在初始化obsClient时调用obs.WithSignature(obs.SignatureObs)指定协议类型。

方法定义

func (obsClient ObsClient) GetBucketInventory(input *GetBucketInventoryInput, extensions ...extensionOptions) (output *GetBucketInventoryOutput, err error)

请求参数说明

表1 GetBucketInventoryInput参数说明

响应参数说明

表2 GetBucketInventoryOutput参数说明

表3 InventoryConfiguration参数说明

表4 InventoryDestination参数说明

表5 InventorySchedule参数说明

表6 InventoryFilter参数说明

表6 InventoryOptionalFields参数说明

代码示例

本示例用于查询桶examplebucket上ID为inventory-rule-1的桶清单配置。

package main

import (
	"fmt"
	"log"
        obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)

func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
        ak := os.Getenv("AccessKeyID")
        sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写。     endPoint := "https://obs.cn-north-4.myhuaweicloud.com"
	// 创建客户端
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }

	// 获取清单配置
	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)
	}
}

相关链接

• 更多关于桶清单的示例代码，请参见Github示例。
• 桶清单接口返回的错误码含义、问题原因及处理措施可参考OBS错误码。