全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
对象存储 OSS

生命周期管理

更新时间:2017-06-07 13:26:11

OSS提供文件生命周期管理来为用户管理对象。用户可以为某个存储空间定义生命周期配置,来为该存储空间的文件定义各种规则。目前,用户可以通过规则来删除相匹配的文件。每条规则都由如下几个部分组成:

  • 文件名称前缀,只有匹配该前缀的文件才适用这个规则
  • 操作,用户希望对匹配的文件所执行的操作。
  • 日期或天数,用户期望在特定日期或者是在文件最后修改时间后多少天执行指定的操作。这里不推荐用户直接使用日期作为文件生命周期管理的方式,使用这种方式,在指定日期之后符合前缀的文件会过期,而不论文件的最后修改时间。

更多关于生命周期的内容请参考 文件生命周期

提示:

  • 以下场景的完整代码参见:GitHub

Lifecycle规则说明

lifecycle的配置规则由一段xml表示。

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <LifecycleConfiguration>
  3. <Rule>
  4. <ID>delete obsoleted files</ID>
  5. <Prefix>obsoleted/</Prefix>
  6. <Status>Enabled</Status>
  7. <Expiration><Days>3</Days></Expiration>
  8. </Rule>
  9. <Rule>
  10. <ID>delete temporary files</ID>
  11. <Prefix>temporary/</Prefix>
  12. <Status>Enabled</Status>
  13. <Expiration><Date>2022-10-12T00:00:00.000Z</Date></Expiration>
  14. </Rule>
  15. </LifecycleConfiguration>

一个Lifecycle的Config里面可以包含多个Rule(最多1000个)。

各字段解释:

  • ID字段是用来唯一表示本条规则。
  • Prefix指定对存储空间下的符合特定前缀的文件使用规则,不能重叠。
  • Status指定本条规则的状态,只有Enabled和Disabled,分别表示启用规则和禁用规则。
  • Expiration节点里面的Days表示大于文件最后修改时间指定的天数就删除文件,Date则表示到指定的绝对时间之后就删除文件(绝对时间服从ISO8601的格式)。

设置Lifecycle规则

您可以通过OssClient::putBucketLifecycle设置存储空间的lifecycle规则:

  1. <?php
  2. /**
  3. * 设置bucket的生命周期配置
  4. *
  5. * @param OssClient $ossClient OssClient实例
  6. * @param string $bucket 存储空间名称
  7. * @return null
  8. */
  9. function putBucketLifecycle($ossClient, $bucket)
  10. {
  11. $lifecycleConfig = new LifecycleConfig();
  12. $actions = array();
  13. $actions[] = new LifecycleAction(OssClient::OSS_LIFECYCLE_EXPIRATION, OssClient::OSS_LIFECYCLE_TIMING_DAYS, 3);
  14. $lifecycleRule = new LifecycleRule("delete obsoleted files", "obsoleted/", "Enabled", $actions);
  15. $lifecycleConfig->addRule($lifecycleRule);
  16. $actions = array();
  17. $actions[] = new LifecycleAction(OssClient::OSS_LIFECYCLE_EXPIRATION, OssClient::OSS_LIFECYCLE_TIMING_DATE, '2022-10-12T00:00:00.000Z');
  18. $lifecycleRule = new LifecycleRule("delete temporary files", "temporary/", "Enabled", $actions);
  19. $lifecycleConfig->addRule($lifecycleRule);
  20. try {
  21. $ossClient->putBucketLifecycle($bucket, $lifecycleConfig);
  22. } catch (OssException $e) {
  23. printf(__FUNCTION__ . ": FAILED\n");
  24. printf($e->getMessage() . "\n");
  25. return;
  26. }
  27. print(__FUNCTION__ . ": OK" . "\n");
  28. }

获取Lifecycle规则

您可以通过OssClient::getBucketLifecycle获取存储空间的lifecycle规则。

  1. <?php
  2. /**
  3. * 获取bucket的生命周期配置
  4. *
  5. * @param OssClient $ossClient OSSClient实例
  6. * @param string $bucket bucket名字
  7. * @return null
  8. */
  9. function getBucketLifecycle($ossClient, $bucket)
  10. {
  11. $lifecycleConfig = null;
  12. try{
  13. $lifecycleConfig = $ossClient->getBucketLifecycle($bucket);
  14. } catch(OssException $e) {
  15. printf(__FUNCTION__ . ": FAILED\n");
  16. printf($e->getMessage() . "\n");
  17. return;
  18. }
  19. print(__FUNCTION__ . ": OK" . "\n");
  20. print($lifecycleConfig->serializeToXml() . "\n");
  21. }

删除Lifecycle规则

您可以通过OssClient::deleteBucketLifecycle清空存储空间中lifecycle规则。

  1. <?php
  2. /**
  3. * 删除bucket的生命周期配置
  4. *
  5. * @param OssClient $ossClient OSSClient实例
  6. * @param string $bucket bucket名字
  7. * @return null
  8. */
  9. function deleteBucketLifecycle($ossClient, $bucket)
  10. {
  11. try{
  12. $ossClient->deleteBucketLifecycle($bucket);
  13. } catch(OssException $e) {
  14. printf(__FUNCTION__ . ": FAILED\n");
  15. printf($e->getMessage() . "\n");
  16. return;
  17. }
  18. print(__FUNCTION__ . ": OK" . "\n");
  19. }
本文导读目录