文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 在线解压策略(Python SDK)/ 设置在线解压策略(Python SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置在线解压策略(Python SDK)

功能介绍

OBS支持ZIP包上传后自动解压并存放在指定目录。桶设置了在线解压策略后，上传到该桶内的ZIP包如果匹配解压策略，ZIP包将会自动解压到指定目录里。本接口用于为指定桶配置ZIP文件解压策略。了解更多在线解压相关信息，请参见在线解压。

融合桶不支持在线解压。

方法定义

ObsClient.setObsCompressPolicy(bucketName, rules, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

rules

list of 表1 ObsCompressPolicyRule

必选

参数解释：

策略规则数组。详见表1 ObsCompressPolicyRule。

约束限制：

同一个桶下的不同策略前缀不能重复和起始包含，委托建议使用同一个。

取值范围：

数组大小[1, 10]。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 ObsCompressPolicyRule

参数名称

参数类型

是否必选

描述

id

str

必选

参数解释：

解压策略名称。当前桶上配置的解压规则的唯一标识。例如：event_0001。

约束限制：

  • 只能由大写或小写的英文字母、数字、下划线（_）和连字符（-）组成。
  • 解压策略名称、解压路径、IAM委托名称长度之和不超过800。

取值范围：

长度最长为256的字符串。

默认取值：

无

project

str

必选

参数解释：

项目ID。

取值范围：

不涉及。

默认取值：

无

agency

str

必选

参数解释：

IAM委托名。

约束限制：

  • 委托需要给OBS服务授予obs:object:PutObject、obs:object:GetObject、obs:object:AbortMultipartUpload权限。
  • 解压策略名称、解压路径、IAM委托名称长度之和不超过800。

默认取值：

无

events

list

必选

参数解释：

触发事件类型。

取值范围：

["ObjectCreated:*"]

["ObjectCreated:Put"]

["ObjectCreated:Post"]

["ObjectCreated:Copy"]

["ObjectCreated:CompleteMultipartUpload"]

默认取值：

无

prefix

str

可选

参数解释：

匹配规则前缀。

取值范围：

长度最长为1023的字符串。

默认取值：

无

suffix

str

必选

参数解释：

匹配规则后缀。

约束限制：

当前仅支持.zip。

取值范围：

.zip。

默认取值：

无

overwrite

int

必选

参数解释：

解压后同名文件的处理方式。

取值范围：

  • 0：不覆盖跳过。
  • 1：不覆盖，以文件的CRC32值重命名。
  • 2：覆盖。

默认取值：

无

decompresspath

str

可选

参数解释：

文件解压后存放的路径。

约束限制：

  • 不为空时必须以“/”结尾，且不能以“/”开头。
  • 解压策略名称、解压路径、IAM委托名称长度之和不超过800。

取值范围：

长度最长为800的字符串。

默认取值：

无

policytype

str

必选

参数解释：

文件解压策略类型。

约束限制：

当前仅支持decompress。

取值范围：

decompress：执行解压操作。

默认取值：

decompress

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表2 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

本示例用于设置examplebucket桶的在线解压策略。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
from obs import ObsClient, ObsCompressPolicyRule
import os
import traceback

# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = 'examplebucket'
    # 设置在线解压策略
    rule = ObsCompressPolicyRule(
        id='rule_id',
        project='your_project_id',
        # 委托需要给OBS服务授予obs:object: PutObject、obs: object:GetObject、obs: object:AbortMultipartUpload权限
        agency='your_agency',
        # 触发事件类型
        events=['ObjectCreated:*'],
        # 匹配规则前缀
        prefix='zip/',
        # 匹配规则后缀
        suffix='.zip',
        # 解压后同名文件的处理方式
        overwrite=0,
        # 文件解压后存放的路径
        decompresspath='decompressed/',
        # 文件解压策略类型，当前仅支持decompress
        policytype='decompress'
    )
    rules = [rule]
    resp = obsClient.setObsCompressPolicy(bucketName, rules)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set CompressPolicy Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set CompressPolicy Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Set CompressPolicy Failed')
    print(traceback.format_exc())

相关文档