# 设置在线解压策略 本接口用于为指定桶配置ZIP文件解压策略。接口是幂等的，如果桶上已存在相同策略内容，则返回成功，status code返回值为200；否则status code返回值为201。 #### 接口约束 - 您必须是桶拥有者或拥有设置在线解压策略的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见[OBS不同权限控制方式的区别](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 - **权限限制：** - 需要使用IAM的角色与策略授权功能，增加Tenant Administrator权限后才能设置、获取、删除在线解压策略。 - 在线解压源需使用IAM创建云服务委托，委托OBS获取桶内数据，上传数据到桶内。委托需要给OBS服务授予obs:object:PutObject、obs:object:GetObject、obs:object:AbortMultipartUpload权限。 - **包及文件大小限制：** - 单个ZIP包大小上限为**1GB**。 - 单个ZIP包内最多可包含65536个文件。 - ZIP包内，单个文件解压后最大为40GB。 - **时间限制：** - ZIP包解压任务最大时长为10分钟。 - **功能限制：** - ZIP包的后缀必须为zip。 - ZIP包名称中不可带有中文标点符号、特殊符号和特殊编码。 - 针对ZIP包嵌套的场景，在线解压策略的事件类型需设置为ObjectCreated:\*或ObjectCreated:CompleteMultipartUpload。 - 目前不支持解压任务完成后给用户发送消息通知。 - 目前仅支持解压压缩算法为deflated的ZIP包，此处的压缩算法与WINRAR等软件提供的Store、Normal等压缩方法不等同。 - 解压路径加上压缩包解压出文件的文件名，总字符长度不可超过512，否则会导致解压失败。 - 目前不支持解压加密ZIP包。 - 不支持企业联邦用户使用在线解压功能，更多关于联邦用户的相关信息请参考[账号与用户的关系](https://support.huaweicloud.com/iam_faq/iam_01_0615.html)和[身份提供商概述](https://support.huaweicloud.com/usermanual-iam/iam_08_0001.html)。 #### 方法定义 **func** (obsClient ObsClient) SetBucketDirectColdAccess(input \*[SetBucketDecompressionInput], extensions ...extensionOptions) (output \*[BaseModel], err error) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | \*[SetBucketDecompressionInput] | 必选 | **参数解释：** 设置在线解压策略请求参数，详见[SetBucketDecompressionInput]。 | | 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)。 | 表2SetBucketDecompressionInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶命名规则如下： - 需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。用户删除桶后，立即创建同名桶或并行文件系统会创建失败，需要等待30分钟才能创建。 - 长度范围为3到63个字符，仅支持小写字母、数字、中划线（-）、英文句号（.）。 - 禁止两个英文句号（.）相邻，禁止英文句号（.）和中划线（-）相邻，禁止以英文句号（.）和中划线（-）开头或结尾。 - 禁止使用IP地址。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | Rules | \[\][DecompressionRule] | 必选 | **参数解释：** 在线解压策略。 **取值范围：** 参见[DecompressionRule]。 **默认取值：** 无 | 表3DecompressionRule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 必选 | **参数解释：** 解压策略名称。当前桶上配置的解压规则的唯一标识。 **取值范围：** \[1, 256\]，满足"\^\[a-zA-Z0-9_-\]{1, 256}$"，即长度为1\~256个字符。只能由大写或小写的英文字母、数字、下划线（_）和连字符（-）组成。例如：event_0001。 **默认取值：** 无 | | Project | string | 必选 | **参数解释：** 项目ID。 **默认取值：** 无 | | Agency | string | 必选 | **参数解释：** 委托名。客户通过委托赋予OBS服务查询用户桶内指定对象是否存在以及向用户桶内上传对象的权限。 **默认取值：** 无 | | Events | \[\]string | 必选 | **参数解释：** 触发事件类型。 **取值范围：** ``` ["ObjectCreated:*"] ["ObjectCreated:Put"] ["ObjectCreated:Post"] ["ObjectCreated:Copy"] ["ObjectCreated:CompleteMultipartUpload"] ``` | | Prefix | string | 可选 | **参数解释：** 匹配规则前缀。 **取值范围：** \[0, 1023\] | | Suffix | string | 必选 | **参数解释：** 匹配规则后缀。 **取值范围：** 固定值：.zip | | Overwrite | int | 必选 | **参数解释：** 解压后同名文件的处理方式。 **取值范围：** - 0：不覆盖跳过 - 1：不覆盖，以文件的CRC32值重命名 - 2：覆盖。 | | DecompressPath | string | 可选 | **参数解释：** 文件解压后存放的路径，不为空时必须以"/"结尾，且不能以"/"开头。 **取值范围：** \[0, 800\] | | PolicyType | string | 必选 | **参数解释：** 文件解压策略类型。 **取值范围：** 固定值：decompress：执行解压操作 | #### 返回结果说明 表4返回结果列表 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | output | \*[BaseModel] | **参数解释：** 接口返回信息，详见[BaseModel]。 | | err | error | **参数解释：** 接口返回错误信息。 | 表5BaseModel | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | 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响应头信息。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 代码示例 本示例用于设置examplebucket桶的在线解压策略。 ``` package main import ( "fmt" "os" "time" ) 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.SetBucketDecompressionInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定在线解压策略 var rules []obs.DecompressionRule rule := obs.DecompressionRule{} rule.ID = fmt.Sprintf("rule-%d", time.Now().Unix()) rule.Project = "your-project-id" rule.Agency = "your-agency-name" rule.Events = []string{"ObjectCreated:Post"} rule.Prefix = "compressed/" rule.Suffix = ".zip" rule.Overwrite = 1 rule.DecompressPath = "extracted/" rule.PolicyType = "decompress" rules = append(rules, rule) input.Rules = rules // 设置在线解压策略 output, err := obsClient.SetBucketDecompression(input) if err == nil { fmt.Printf("Set bucket(%s)'s decompression policy successful!\n", input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Set bucket(%s)'s decompression policy 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) } } ``` #### 相关链接 - 关于设置在线解压策略的API说明，请参见[设置在线解压策略](https://support.huaweicloud.com/api-obs/obs_04_0148.html)。 - 设置在线解压策略过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 设置在线解压策略相关问题请参见[在线解压](https://support.huaweicloud.com/usermanual-obs/obs_03_0368.html)。