文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 获取桶的生命周期配置(Python SDK)
更新时间：2024-11-26 GMT+08:00
查看PDF
分享

获取桶的生命周期配置(Python SDK)

功能介绍

OBS支持用户配置指定的规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用，更多生命周期相关信息请参见生命周期管理。

调用获取桶的生命周期配置接口，您可以获取指定桶的生命周期策略。

接口约束

  • 您必须是桶拥有者或拥有获取桶的生命周期配置的权限，才能获取桶的生命周配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetLifecycleConfiguration权限，如果使用桶策略则需授予GetLifecycleConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.getBucketLifecycle(bucketName, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表1 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

GetResult.body类型

说明

LifecycleResponse

参数解释：

获取桶生命周期配置响应结果。

默认取值：

无
表2 LifecycleResponse

参数名称

参数类型

描述

lifecycleConfig

Lifecycle

参数解释：

桶生命周期配置，详见Lifecycle。

默认取值：

无
表3 Lifecycle

参数名称

参数类型

是否必选

描述

rule

list of Rule

作为请求参数时必选

参数解释：

桶生命周期规则列表，详见Rule。

默认取值：

无
表4 Rule

参数名称

参数类型

是否必选

描述

id

str

作为请求参数时可选

参数解释：

生命周期规则ID。

取值范围：

长度大于0且不超过255的字符串。

默认取值：

无

prefix

str

作为请求参数时必选

参数解释：

对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。

例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将ExampleObject.jpg指定为前缀，则规则仅应用于该特定对象。如果您将logs/指定为前缀，规则将应用于密钥名称以字符串“logs/”开头的三个对象。如果您指定空的前缀，规则将应用于桶中的所有对象。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

status

str

作为请求参数时必选

参数解释：

标识当前这条规则是否启用

取值范围：

  • Enabled：启用
  • Disabled：停用

默认取值：

无

transition

Transition

或

list of Transition

作为请求参数时可选

参数解释：

对象转换策略列表，用于使用生命周期规则转换对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见Transition。

约束限制：

仅针对对象的最新版本。

默认取值：

无

expiration

Expiration

作为请求参数时可选

参数解释：

对象过期时间配置，详见Expiration。

约束限制：

仅针对对象的最新版本。

默认取值：

无

noncurrentVersionTransition

NoncurrentVersionTransition

或

list of NoncurrentVersionTransition

作为请求参数时可选

参数解释：

历史版本对象转换策略列表，用于使用生命周期规则转换历史版本对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见NoncurrentVersionTransition。

约束限制：

  • 仅针对对象的历史版本。
  • 当前桶已启用（或开启后暂停）多版本。
  • 不用于设置并行文件系统。

默认取值：

无

noncurrentVersionExpiration

NoncurrentVersionExpiration

作为请求参数时可选

参数解释：

历史版本对象过期时间配置，详见NoncurrentVersionExpiration。

约束限制：

  • 仅针对对象的历史版本。
  • 当前桶已启用（或开启后暂停）多版本。
  • 不用于设置并行文件系统。

默认取值：

无
表5 Transition

参数名称

参数类型

是否必选

描述

storageClass

str

作为请求参数时必选

参数解释：

对象转换后的存储类型。

约束限制：

  • 不支持“标准存储”类型。
  • 对象存储类别转换限制：
    • 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
    • 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。
    • 归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见存储类型。

默认取值：

无

date

str

或

DateTime

作为请求参数时，如果没有设置days则必选

参数解释：

表示对象转换的日期。

约束限制：

日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象转换成其他存储类型，等于或晚于这个时间的对象不会转换成其他存储类型。

代码示例：DateTime(year=2023, month=9, day=12)。

默认取值：

无

days

int

作为请求参数时，如果没有设置date则必选

参数解释：

指定生命周期规则在对象最后更新过后多少天生效。

约束限制：

仅适用于对象的最新版本。

取值范围：

大于等于0的整型数，单位：天

默认取值：

无
表6 StorageClass

参数名称

参数类型

描述

STANDARD

标准存储

参数解释：

标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。

WARM

低频访问存储

参数解释：

低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。

COLD

归档存储

参数解释：

归档存储适用于很少访问（平均一年访问一次）数据的业务场景。
表7 Expiration

参数名称

参数类型

是否必选

描述

date

str

或

DateTime

作为请求参数时，如果没有设置days则必选

参数解释：

指定OBS对该日期之前的对象执行生命周期规则，即执行过期删除操作。

约束限制：

日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象删除，等于或晚于这个时间的对象不会被删除。

代码示例：DateTime(year=2023, month=9, day=12)。

默认取值：

无

days

int

作为请求参数时，如果没有设置date则必选

参数解释：

指定生命周期规则在对象最后更新过后多少天生效，即执行过期删除操作。

约束限制：

仅适用于对象的最新版本。

取值范围：

大于等于0的整型数，单位：天

默认取值：

无
表8 DateTime

参数名称

参数类型

描述

year

int

参数解释：

UTC时间中的年。

默认取值：

无

month

int

参数解释：

UTC时间中的月。

默认取值：

无

day

int

参数解释：

UTC时间中的日。

默认取值：

无

hour

int

参数解释：

UTC时间中的小时。

约束限制：

24小时制。

默认取值：

0

min

int

参数解释：

UTC时间中的分钟。

默认取值：

0

sec

int

参数解释：

UTC时间中的秒数。

默认取值：

0
表9 NoncurrentVersionTransition

参数名称

参数类型

是否必选

描述

storageClass

str

作为请求参数时必选

参数解释：

历史版本对象转换后的存储类型。

约束限制：

  • 不支持“标准存储”类型。
  • 对象存储类别转换限制：
    • 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。
    • 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动恢复对象，然后手动转换存储类别。
    • 归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档存储。

取值范围：

生命周期转换的目标存储类别取值范围详见存储类型。

默认取值：

无

noncurrentDays

int

作为请求参数时必选

参数解释：

表示对象在成为历史版本之后第几天时规则生效。

约束限制：

仅针对历史版本。

取值范围：

大于等于 0 的整型数，单位：天

默认取值：

无
表10 NoncurrentVersionExpiration

参数名称

参数类型

是否必选

描述

noncurrentDays

int

作为请求参数时必选

参数解释：

表示对象在成为历史版本之后第几天时规则生效。

约束限制：

仅针对历史版本。

取值范围：

大于等于0的整型数，单位：天

默认取值：

无

代码样例

本示例用于获取名为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
 
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName="examplebucket"
    #获取桶的生命周期规则
    resp = obsClient.getBucketLifecycle(bucketName)
    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Get Bucket Lifecycle Succeeded')
        print('requestId:', resp.requestId)
        index = 1
        for rule in resp.body.lifecycleConfig.rule:
            print('rule [' + str(index) + ']')
            print('id:', rule.id)
            print('prefix:', rule.prefix)
            print('status:', rule.status)
            if rule.expiration:
                print('days:', rule.expiration.days)
                print('date:', rule.expiration.date)
            if rule.noncurrentVersionExpiration:
                print('noncurrentDays:', rule.noncurrentVersionExpiration.noncurrentDays)
        index += 1
    else:
        print('Get Bucket Lifecycle Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Get Bucket Lifecycle Failed')
    print(traceback.format_exc())

相关链接

  • 关于获取桶的生命周期配置的API说明，请参见获取桶的生命周期配置。
  • 更多关于获取桶的生命周期配置的示例代码，请参见Github示例。
  • 获取桶的生命周期配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。