设置桶的生命周期配置
功能介绍
OBS系统支持指定规则来实现定时删除或迁移桶中对象,这就是生命周期配置。典型的应用场景如:
- 周期性上传的日志文件,可能只需要保留一个星期或一个月,到期后要删除它们。
- 某些文档在一段时间内经常访问,但是超过一定时间后就可能不会再访问了。这种文档您可能会先选择归档,然后在一定时间后删除。
本接口实现为桶创建或更新生命周期配置信息。
- 对象生命周期到期以后,对象将会永久删除,无法恢复。
要正确执行此操作,需要确保执行者有PutLifecycleConfiguration权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。
生命周期配置实现了定时删除对象和定时迁移对象的功能,所以如果想要阻止用户删除或迁移对象,以下几项操作的权限都应该被禁止:
- DeleteObject
- DeleteObjectVersion
- PutLifecycleConfiguration
如果想要阻止用户管理桶的生命周期配置,应该禁止PutLifecycleConfiguration权限。
请求消息样式
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 | PUT /?lifecycle HTTP/1.1 Host: bucketname.obs.region.example.com Content-Length: length Date: date Authorization: authorization Content-MD5: MD5 <?xml version="1.0" encoding="UTF-8"?> <LifecycleConfiguration> <Rule> <ID>id</ID> <Prefix>prefix</Prefix> <Status>status</Status> <Expiration> <Days>days</Days> </Expiration> <NoncurrentVersionExpiration> <NoncurrentDays>days</NoncurrentDays> </NoncurrentVersionExpiration> <Transition> <Days>30</Days> <StorageClass>WARM</StorageClass> </Transition> <Transition> <Days>60</Days> <StorageClass>COLD</StorageClass> </Transition> <NoncurrentVersionTransition> <NoncurrentDays>30</NoncurrentDays> <StorageClass>WARM</StorageClass> </NoncurrentVersionTransition> <NoncurrentVersionTransition> <NoncurrentDays>60</NoncurrentDays> <StorageClass>COLD</StorageClass> </NoncurrentVersionTransition> <AbortIncompleteMultipartUpload> <DaysAfterInitiation>10</DaysAfterInitiation> </AbortIncompleteMultipartUpload> </Rule> </LifecycleConfiguration> |
请求消息参数
该请求消息中不使用消息参数。
请求消息头
该请求使用的消息头如下表1所示。
请求消息元素
在此请求中,需要在请求的消息体中配置桶的生命周期配置信息。配置信息以XML格式上传,具体的配置元素如表2描述。
- 如果桶的多版本是Enabled或者Suspended,那么可以设置NoncurrentVersionTransition或NoncurrentVersionExpiration来控制对象的历史版本的生命周期。一个历史版本的生命周期,取决于它成为历史版本的时刻(即被新版本覆盖的那个时刻)和NoncurrentDays。对于删除来说,例如NoncurrentDays配置为1的话,表示当一个版本成为历史版本之后,再过1天才能删除。对象A的版本V1创建于1号,5号的时候又上传新的版本V2,此时V1成为历史版本,那么再过1天,7号的0点,V1就过期了。如果该版本不满足删除,迁移配置NoncurrentDays为1,StorageClass为WARM的话,表示当一个版本成为历史版本之后,再过1天转为温存储对象。对象A的版本V1创建于1号,5号的时候又上传新的版本V2,此时V1成为历史版本,那么再过1天,7号的0点,V1就会迁移成温存储对象了。(备注:对象过期后被删除或对象迁移的时间可能会有一定的延迟,一般不超过48小时。)
- 如果桶的多版本是Enabled或者Suspended,且最新版本对象满足Expiration规则时的处理:
- 桶当前的多版本状态为Enabled:
如果对象的最新版本不是deletemarker,则该对象会产生一个新的deletemarker;
如果最新版本是deletemarker,且该对象只有这一个版本,则这个版本会被删除;
如果最新版本是deletemarker,且对象还有其他版本,则该对象的所有版本维持不变,没有新增和删除,也不会被修改(即无任何变化)。
- 桶当前的多版本状态为Suspended:
如果对象的最新版本不是deletemarker,且版本不是null版本,则会产生一个新的null版本的deletemarker;
如果对象的最新版本不是deletemarker,且版本是null版本,则这个null版本会被新产生的null版本的deletemarker覆盖;
如果最新版本是deletemarker,且该对象只有这一个版本,则这个版本会被删除;
如果最新版本是deletemarker,且对象还有其他版本,则该对象的所有版本维持不变,没有新增和删除,也不会被修改(即无任何变化)。
- 桶当前的多版本状态为Enabled:
- 如果桶的多版本是Enabled或者Suspended,且最新版本对象满足Transition规则时的处理:
- 如果对象的最新版本是deletemarker,则这个版本不被迁移;
- 如果最新版本不是deletemarker,且该对象满足迁移条件,则这个版本会被迁移。
| 参数名称 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| LifecycleConfiguration | 是 | XML | 参数解释: 生命周期配置规则。可以配置多条规则,LifecycleConfiguration是Rule的父节点。 约束限制: 整个配置消息体总大小不超过20KB。 取值范围: 不涉及 默认取值: 不涉及 |
| Rule | 是 | XML | 参数解释: 具体某一条生命周期配置。 约束限制: 不涉及 取值范围: 请详见Rule参数说明。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ID | 否 | String | 参数解释: 一条规则的标识。 约束限制: 只能由大写或小写的英文字母、数字、英文句号(.)、下划线(_)和连字符(-)组成。 取值范围: 长度为0~255的字符串。 默认取值: 不涉及 |
| Prefix | 是 | String | 参数解释: 对象名前缀,用来标识哪些对象可以匹配到当前规则。 约束限制:
取值范围: 长度为0~255的字符串。 默认取值: 不涉及 |
| Transition | 如果没有NoncurrentVersionTransition, Expiration, NoncurrentVersionExpiration则必选 | XML | 参数解释: 生命周期配置中表示转换时间和转换后对象存储级别的元素。 约束限制: 仅针对对象的最新版本。 取值范围: 请详见Transition参数说明。 默认取值: 不涉及 |
| Expiration | 如果没有Transition, NoncurrentVersionTransition, NoncurrentVersionExpiration则必选 | XML | 参数解释: 在生命周期配置中表示过期时间。 约束限制: 仅针对对象的最新版本。 取值范围: 请详见Expiration参数说明。 默认取值: 不涉及 |
| NoncurrentVersionTransition | 如果没有Transition, Expiration, NoncurrentVersionExpiration则必选 | XML | 参数解释: 生命周期配置中表示转换时间和转换后对象存储级别的元素。 约束限制: 仅针对对象的历史版本。 取值范围: 请详见NoncurrentVersionTransition参数说明。 默认取值: 不涉及 |
| NoncurrentVersionExpiration | 否 | XML | 参数解释: 在生命周期配置中表示历史版本的过期时间。您可以将该动作设置在已启用多版本(或暂停)的桶,让系统删除对象的满足特定生命周期的历史版本。 约束限制: 仅针对历史版本。 取值范围: 请详见NoncurrentVersionExpiration参数说明 默认取值: 不涉及 |
| Status | 是 | String | 参数解释: 标识当前规则是否启用。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Date | 如果没有Days元素,则必选 | String | 参数解释: 指定OBS对该日期之前的对象执行生命周期规则。 约束限制: 日期格式必须为ISO8601的格式,并且为UTC的零点。 例如:2018-01-01T00:00:00.000Z,表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象删除或转换成其他存储类型,等于或晚于这个时间的对象不会被删除或转储。 取值范围: 日期格式的字符串。 默认取值: 不涉及 |
| Days | 如果没有Date元素,则必选 | Integer | 参数解释: 指定生命周期规则在对象最后更新过后多少天生效。单位:天。 约束限制: 仅针对对象的最新版本。 取值范围: 取值为0~2147483647的数字。 默认取值: 不涉及 |
| StorageClass | 如果有Transition或NoncurrentVersionTransition元素,则必选 | String | 参数解释: 表示对象将被修改成的目标存储类别。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Date | 如果没有Days元素,则必选 | String | 参数解释: 指定OBS对该日期之前的对象执行生命周期规则。 约束限制: 日期格式必须为ISO8601的格式,并且为UTC的零点。 例如:2018-01-01T00:00:00.000Z,表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象删除或转换成其他存储类型,等于或晚于这个时间的对象不会被删除或转储。 取值范围: 日期格式的字符串。 默认取值: 不涉及 |
| Days | 如果没有Date元素,则必选 | Integer | 参数解释: 指定生命周期规则在对象最后更新过后多少天生效。单位:天。 约束限制: 仅针对对象的最新版本。 取值范围: 取值为0~2147483647的数字。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| NoncurrentDays | 如果有NoncurrentVersionExpiration或NoncurrentVersionTransition元素,则必选 | Integer | 参数解释: 表示对象在成为历史版本之后第几天时规则生效。单位:天。 约束限制: 仅针对历史版本。 取值范围:
默认取值: 不涉及 |
| StorageClass | 如果有Transition或NoncurrentVersionTransition元素,则必选 | String | 参数解释: 表示对象将被修改成的目标存储类别。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应消息样式
1 2 3 | HTTP/1.1 status_code Date: date Content-Length: length |
响应消息头
该请求的响应消息使用公共消息头,具体请参考表1。
响应消息元素
该请求的响应消息不带消息元素。
错误响应消息
无特殊错误,所有错误已经包含在表2中。
请求示例
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 | PUT /?lifecycle HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.region.example.com Accept: */* Date: WED, 01 Jul 2015 03:05:34 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI= Content-MD5: ujCZn5p3fmczNiQQxdsGaQ== Content-Length: 919 <?xml version="1.0" encoding="utf-8"?> <LifecycleConfiguration> <Rule> <ID>lifecycle-rule-id</ID> <Prefix>test/</Prefix> <Status>Enabled</Status> <Expiration> <Days>70</Days> </Expiration> <NoncurrentVersionExpiration> <NoncurrentDays>70</NoncurrentDays> </NoncurrentVersionExpiration> <Transition> <Days>30</Days> <StorageClass>WARM</StorageClass> </Transition> <Transition> <Days>60</Days> <StorageClass>COLD</StorageClass> </Transition> <NoncurrentVersionTransition> <NoncurrentDays>30</NoncurrentDays> <StorageClass>WARM</StorageClass> </NoncurrentVersionTransition> <NoncurrentVersionTransition> <NoncurrentDays>60</NoncurrentDays> <StorageClass>COLD</StorageClass> </NoncurrentVersionTransition> <AbortIncompleteMultipartUpload> <DaysAfterInitiation>10</DaysAfterInitiation> </AbortIncompleteMultipartUpload> </Rule> </LifecycleConfiguration> |
响应示例
1 2 3 4 5 6 | HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF26000001643670AC06E7B9A7767921 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm Date: WED, 01 Jul 2015 03:05:34 GMT Content-Length: 0 |