# 获取桶级WORM保护策略 #### 功能介绍 当桶设置了桶级默认WORM策略，可以通过本接口获取该桶的桶级默认WORM策略。 ![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png) 如果您打开了桶级WORM开关，但从未配置过桶级默认WORM策略，您依然可以使用此接口查看开关的打开情况。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶级WORM保护策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketObjectLockConfiguration权限，如果使用桶策略则需授予GetBucketObjectLockConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 **func** (obsClient ObsClient) GetBucketWormConfiguration(BucketName \*string, extensions ...extensionOptions) (output \*[GetBucketWormConfigurationOutput], err error) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | BucketName | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶命名规则如下： - 需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。用户删除桶后，立即创建同名桶或并行文件系统会创建失败，需要等待30分钟才能创建。 - 长度范围为3到63个字符，仅支持小写字母、数字、中划线（-）、英文句号（.）。 - 禁止两个英文句号（.）相邻，禁止英文句号（.）和中划线（-）相邻，禁止以英文句号（.）和中划线（-）开头或结尾。 - 禁止使用IP地址。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | extensions | [extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html) | 可选 | **参数解释：** 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考[extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html)。 | #### 返回结果说明 表2返回结果列表 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | output | \*[GetBucketWormConfigurationOutput] | **参数解释：** 接口返回信息，详见[GetBucketWormConfigurationOutput]。 | | err | error | **参数解释：** 接口返回错误信息。 | 表3GetBucketWormConfigurationOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | StatusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | ResponseHeaders | map\[string\]\[\]string | **参数解释：** HTTP响应头信息。 **默认取值：** 无 | | ObjectLockEnabled | string | 可选 **参数解释：** 桶级WORM开关状态。 **约束限制：** 不涉及 **取值范围：** Enabled：启用桶级WORM功能。 **默认取值：** 不涉及 | | Rule | \*[Rule] | 可选 **参数解释：** 桶级WORM策略。 **约束限制：** ObjectLockEnabled为Enabled时必选，不携带则会清空当前配置的桶级默认WORM策略 **取值范围：** 请详见[Rule]。 **默认取值：** 不涉及 | 表4Rule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | DefaultRetention | \*[DefaultRetention] | 必选 | **参数解释：** 桶级WORM策略。 **约束限制：** 不涉及 **取值范围：** 请详见[DefaultRetention]。 **默认取值：** 不涉及 | 表5DefaultRetention | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Mode | string | 必选 | **参数解释：** 桶的WORM保护策略。 **约束限制：** 不涉及 **取值范围：** COMPLIANCE：合规模式。 **默认取值：** 不涉及 | | Days | int | 可选 | **参数解释：** 保护天数。单位：天。 **约束限制：** Days和Years只能有一个不为0，并且在规定取值范围内。 **取值范围：** 1\~36500 **默认取值：** 不涉及 | | Years | int | 可选 | **参数解释：** 默认的保护年数，单位：年。 **约束限制：** - 一年实际上视为保护365天，不考虑闰年。 - Days和Years只能有一个不为0，并且在规定取值范围内。 **取值范围：** 1\~100 **默认取值：** 不涉及 | #### 代码示例 本示例用于获取名为examplebucket桶的桶级默认WORM策略。 ``` package main import ( "fmt" "os" ) func main() { // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK。 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实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken)) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } input := &obs.GetBucketWormConfigurationInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 获取桶级默认WORM策略 output, err := obsClient.GetBucketWormConfiguration(input.Bucket) if err == nil { fmt.Printf("Get bucket(%s)'s WORM configuration successful!\n", input.Bucket) fmt.Printf("ObjectLockEnabled: %s\n", output.ObjectLockEnabled) if output.Rule != nil && output.Rule.DefaultRetention != nil { fmt.Printf("DefaultRetention Mode: %s\n", output.Rule.DefaultRetention.Mode) fmt.Printf("DefaultRetention Days: %d\n", output.Rule.DefaultRetention.Days) } fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Get bucket(%s)'s WORM configuration fail!\n", input.Bucket) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") fmt.Println(err) } } ``` #### 相关链接 - 关于获取桶级默认WORM策略API说明，请参见[配置桶级默认WORM策略](https://support.huaweicloud.com/api-obs/obs_04_0167.html)。 - 获取桶级默认WORM策略过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 了解更多桶级默认WORM策略相关信息，请参见[配置对象锁定（WORM）防止对象被更改或删除](https://support.huaweicloud.com/usermanual-obs/obs_03_0718.html)。