Put Bucket Lifecycle

最近更新时间:2019-01-14 10:10:57

Put Bucket Lifecyle


描述

此PUT接口会设置一个Bucket的lifecyle规则。如果某个Bucket之前已经有lifecycle规则,新添加的规则将完全覆盖旧的,请注意这一点以免误删。
规则的作用是ks3内部会自动去删除匹配到的object,省去用户自己删除的麻烦。
如果要使用此接口,你需要是这个Bucket的owner。

请求

语法

PUT /?lifecycle HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}
Content-length: {length}
Content-MD5: {md5}

Lifecycle configuration in the request body

注意:

请求参数

该接口不使用请求参数。

请求头部

除公共头部外,本接口必须有下面一项

名称 描述 必须
Content-MD5 body里data的128位md5 digest,再用base64编码。这个header必须存在,以便检查body是否损坏。详见RFC-1864
类型: String
默认值: 无

请求Body

一段描述lifecyle configuration的xml。

<LifecycleConfiguration>
  <Rule>
    <ID>id1</ID>
    <Filter>
      <Prefix>documents/</Prefix>
    </Filter>
    <Expiration>
      <Date>2016-12-31T00:00:00.000Z</Date>
    </Expiration>
    <Status>Enabled</Status>
  </Rule>
  <Rule>
    <ID>id2</ID>
    <Filter>
      <Prefix>logs/</Prefix>
    </Filter>
    <Status>Enabled</Status>
    <Expiration>
      <Days>3</Days>
    </Expiration>
  </Rule>
  <Rule>
    <ID>id3</ID>
    <Filter>
      <Prefix>pic</Prefix>
    </Filter>
    <Status>Enabled</Status>
    <Expiration>
      <Date>2018-01-01T00:00:00.000Z</Date>
    </Expiration>
  </Rule>
</LifecycleConfiguration>

Rule就是规则,主要包含:

  • Filter, 规定前缀,object key是该前缀,该object才适用这条规则。如规定了log的前缀,object key是log1,log2,log/2016开头的都会被删。
  • Status, 指定这条规则是启用还是禁用
  • Expiration, object过期的描述,哪个时间之前过期,或存在多少天就过期


注意:

  • 规则的执行在每天0点。
  • 一个Bukcet rule总条数 <= 100
  • Rule的ID在一个bucket内必须唯一,不同bucket可以相同。ID可以是任意字符串,包括中文,但不能超过255字符(utf8编码)。
  • 一个bucket里可以有多条rule,每条rule有不同的prefix,如logs和docs。但是不同rule的prefix不能冲突,如logs和logs2016就是冲突的。
  • Days指定相对时间,是相对object的last modfiy time,如object在2017-01-02 15:05被modify,Days是2,删除发生在2017-01-05 00:00,即顺延2天再找到下一个0点。
    注意这里说的object last modify time,是上一次PUT,POST,COPY的时间。
  • Date指定绝对时间,必须是2017-01-01T00:00:00+08:00 这样ISO 8601格式, 北京时间, 时分秒必须写成0点,传非0点会报错。该规则会在Date指定的那天0点执行,把last modify time<=该Date的object删除; 如果Date是过去时间,该规则在当天深夜就会执行,执行时判断last modify time <= 该Date; 如果是未来时间,该规则在到达那个Date才会被执行,执行时仍然判断last modify time <= 该Date。


xml中的节点具体如下:

名称 描述 是否必须
LifecycleConfiguration 包含一堆Rule的容器, 一个Bucket最多100条Rule。
类型:Container
子节点: Rule
父节点:无
Rule 包含一条规则
类型:Container
父节点:LifecycleConfiguration
ID Rule的唯一标识, 一个Bucket内ID不能重复。ID长度<=255字符,注意是utf8编码字符,不是字节
类型:String
父节点:Rule
Filter 规定前缀,一个Rule只能有一个Filter, 不同rule的prefix不能冲突。
类型:Container
子节点:Prefix
父节点:Rule
Prefix 符合这个前缀的object才会被删。一个Rule只能有一个Filter和一个Prefix
类型:String
父节点:Filter
Status Enabled状态,该Rule就定期被执行;Disabled,该Rule被忽略,但该Rule随时能被Enable而不是被删。
类型:String
父节点:Rule
取值: Enabled, Disabled
Expiration 规定对应的object何时被删。
类型:Container

子节点:Days,Date
父节点:Rule
Date last modify day<这个数的object被删。必须是ISO 8601格式的北京时间。时分秒必须填0,即必须是0点。
类型:String
父节点: Expiration
是,如果没有Days
Days 规定一个正数,对应object在last modify多少天之后被删。
类型: 整数
父节点: Expiration
是,如果没有Date


其中,

  • ID必须有。不同Rule的ID不能重复。
  • Date和Days只能二选一,并且不能不选,必须填写其中一个。
  • Status节点一定要有。
  • Expiration一定要有。
  • Filter和prefix可以没有。但如果有prefix,不同rule之间不能冲突,如log和log2016就是冲突的。
  • Rule的子节点里,应该出现的,都只能出现一次。如ID,只能有一个;Status,只能有一个。

响应头部

本接口只带有常用响应头部。获取更多信息,请点击常用响应头部

响应内容

不返回内容。

特殊错误

不返回任何特殊错误。

示例

请求示例

PUT /?lifecycle HTTP/1.1
Host: ks3-example.kss.ksyun.com
Date: Wed, 14 May 2014 02:11:21 GMT
Content-MD5: xxx 
Authorization: authorization string
Content-Length: yyy
Content-type: application/xml

<LifecycleConfiguration>
  <Rule>
    <ID>id1</ID>
    <Filter>
      <Prefix>documents/</Prefix>
    </Filter>
    <Expiration>
      <Date>2016-12-31T00:00:00+08:00</Date>
    </Expiration>
    <Status>Enabled</Status>
  </Rule>
  <Rule>
    <ID>id2</ID>
    <Filter>
      <Prefix>logs/</Prefix>
    </Filter>
    <Status>Enabled</Status>
    <Expiration>
      <Days>3</Days>
    </Expiration>
  </Rule>
  <Rule>
    <ID>id3</ID>
    <Filter>
      <Prefix>pic</Prefix>
    </Filter>
    <Status>Enabled</Status>
    <Expiration>
      <Date>2018-01-01T00:00:00.000Z</Date>
    </Expiration>
  </Rule>
</LifecycleConfiguration>


以上在某个bucket里设2条规则。第一条删除2016-12-31 0点前的以documents开头的object key。第二条让logs开头的在最终modify后3天删除。第三条是未来时间,在2018.1.1才会执行,执行效果是删除lastmodify<2018-01-01的。

响应示例

HTTP/1.1 200 OK
Content-Length: 0
Date: Tue, 19 Jul 2017 09:14:23 GMT
Server: Tengine
x-kss-request-id: 54a47bda18ac4e6e91de369add54218e
x-kss-request-id: 54a47bda18ac4e6e91de369add54218e

金山云,开启您的云计算之旅

立即注册