本文介绍如何使用PHP SDK V2管理存储空间（Bucket）的生命周期功能。
背景信息
在OSS中，并非所有上传的数据都需要频繁访问，但出于数据合规性或归档需求，部分数据仍需以冷存储的形式保存。根据业务需求，您可以选择：
基于最后修改时间（Last Modified Time）的生命周期规则：当某些数据长时间未被修改且不再需要保留时，可以通过此规则批量删除它们，或将其转换为冷存储类型，从而释放存储空间。
基于最后访问时间（Last Access Time）的生命周期规则：如果希望OSS自动监测数据的访问模式来识别冷数据并动态转换存储类型，可启用此规则。OSS将自动识别长期未被访问的数据，将其转换为更经济的冷存储，从而实现冷热分层，降低存储成本。
注意事项
在配置基于最后一次修改时间或者最后一次访问时间的生命周期规则之前，请确保您已了解该功能。详情请参见基于最后一次修改时间的生命周期规则和基于最后一次访问时间的生命周期规则。
本文示例代码以华东1（杭州）的地域ID
cn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。要设置生命周期规则，您必须有
oss:PutBucketLifecycle权限；要查看生命周期规则，您必须有oss:GetBucketLifecycle权限；要清空生命周期规则，您必须有oss:DeleteBucketLifecycle权限。具体操作，请参见为RAM用户授权自定义的权限策略。
设置生命周期规则
以下代码分别提供了设置基于最后一次修改时间和基于最后一次访问时间的生命周期规则的示例。设置完成后，如果您希望修改其中的一条或多条生命周期规则，请参见如何修改其中一条或多条生命周期规则配置？。
基于最后一次修改时间策略执行转换文件存储类型
以下代码用于为Bucket设置基于最后一次修改时间策略，以执行转换文件存储类型的操作。
<?php
// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
use AlibabaCloud\Oss\V2\Models\LifecycleConfiguration;
// 定义命令行参数描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located', 'required' => True], // 区域是必填项 存储空间所在的区域
"endpoint" => ['help' => 'The domain names that other services can use to access OSS', 'required' => False], // 终端节点是可选项 其他服务可以用来访问OSS的域名
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
];
// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
exit(1);
}
}
// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);
// 设置区域
$cfg->setRegion($region);
// 如果提供了终端节点 则设置终端节点
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 定义生命周期规则 将前缀为log/的对象在30天后转换为低频存储类型
$lifecycleRule = new Oss\Models\LifecycleRule(
prefix: 'log/', // 对象前缀
transitions: array(
new Oss\Models\LifecycleRuleTransition(
days: 30, // 转换时间为30天
storageClass: 'IA' // 转换为目标存储类型为低频访问
)
),
id: 'rule', // 规则ID
status: 'Enabled' // 规则状态为启用
);
// 创建生命周期配置对象 并添加生命周期规则
$lifecycleConfiguration = new LifecycleConfiguration(
rules: array($lifecycleRule)
);
// 创建设置存储空间生命周期的请求对象 并将生命周期配置传入
$request = new Oss\Models\PutBucketLifecycleRequest(
bucket: $bucket,
lifecycleConfiguration: $lifecycleConfiguration
);
// 调用putBucketLifecycle方法设置存储空间的生命周期规则
$result = $client->putBucketLifecycle($request);
// 打印返回结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
'request id:' . $result->requestId . PHP_EOL // 请求的唯一标识
);
基于最后一次修改时间策略限制除指定前缀、标签以外的文件执行转换存储类型操作
以下代码用于指定Bucket中除前缀为log、包含key为key1，value为value1标签且符合指定大小以外的文件在距离最后一次修改时间30天后转低频访问类型，过期时间为100天。
<?php
// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
use AlibabaCloud\Oss\V2\Models\LifecycleConfiguration;
// 定义命令行参数描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located', 'required' => True], // 区域是必填项 存储空间所在的区域
"endpoint" => ['help' => 'The domain names that other services can use to access OSS', 'required' => False], // 终端节点是可选项 其他服务可以用来访问OSS的域名
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
];
// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
exit(1);
}
}
// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);
// 设置区域
$cfg->setRegion($region);
// 如果提供了终端节点 则设置终端节点
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 定义生命周期规则 将前缀为log/的对象在30天后转换为归档存储类型
$lifecycleRule = new Oss\Models\LifecycleRule(
id: 'rule', // 规则ID
status: 'Enabled', // 规则状态为启用
prefix: 'log', // 对象前缀
transitions: array(
new Oss\Models\LifecycleRuleTransition(
days: 30, // 转换时间为30天
storageClass: 'Archive' // 转换为目标存储类型为归档存储
)
),
filter: new Oss\Models\LifecycleRuleFilter( // 定义过滤条件
not: new Oss\Models\LifecycleRuleNot( // 定义排除条件
prefix: 'log', // 排除前缀为log的对象
tag: new Oss\Models\Tag( // 定义标签条件
key: 'key1',
value: 'value1'
)
)
),
expiration: new Oss\Models\LifecycleRuleExpiration(
days: 100 // 过期时间为100天
)
);
// 创建生命周期配置对象 并添加生命周期规则
$lifecycleConfiguration = new LifecycleConfiguration(
rules: array($lifecycleRule)
);
// 创建设置存储空间生命周期的请求对象 并将生命周期配置传入
$request = new Oss\Models\PutBucketLifecycleRequest(
bucket: $bucket,
lifecycleConfiguration: $lifecycleConfiguration
);
// 调用putBucketLifecycle方法设置存储空间的生命周期规则
$result = $client->putBucketLifecycle($request);
// 打印返回结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
'request id:' . $result->requestId . PHP_EOL // 请求的唯一标识
);
基于最后一次访问时间策略转换文件存储类型
以下代码用于为Bucket设置基于最后一次访问时间策略，以执行转换存储类型的操作。
<?php
// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
use AlibabaCloud\Oss\V2\Models\LifecycleConfiguration;
// 定义命令行参数描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located', 'required' => True], // 区域是必填项 存储空间所在的区域
"endpoint" => ['help' => 'The domain names that other services can use to access OSS', 'required' => False], // 终端节点是可选项 其他服务可以用来访问OSS的域名
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
];
// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
exit(1);
}
}
// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);
// 设置区域
$cfg->setRegion($region);
// 如果提供了终端节点 则设置终端节点
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 定义生命周期规则 将前缀为log/的对象在30天后转换为低频存储类型
$lifecycleRule = new Oss\Models\LifecycleRule(
prefix: 'log/', // 对象前缀
transitions: array(
new Oss\Models\LifecycleRuleTransition(
days: 30, // 转换时间为30天
storageClass: 'IA', // 转换为目标存储类型为低频访问
IsAccessTime: 'true', // 是否基于访问时间触发转换
ReturnToStdWhenVisit: 'true' // 访问时是否返回标准存储
)
),
id: 'rule', // 规则ID
status: 'Enabled' // 规则状态为启用
);
// 创建生命周期配置对象 并添加生命周期规则
$lifecycleConfiguration = new LifecycleConfiguration(
rules: array($lifecycleRule)
);
// 创建设置存储空间生命周期的请求对象 并将生命周期配置传入
$request = new Oss\Models\PutBucketLifecycleRequest(
bucket: $bucket,
lifecycleConfiguration: $lifecycleConfiguration
);
// 调用putBucketLifecycle方法设置存储空间的生命周期规则
$result = $client->putBucketLifecycle($request);
// 打印返回结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
'request id:' . $result->requestId . PHP_EOL // 请求的唯一标识
);
查看生命周期规则
以下代码用于查看生命周期规则中包含的信息。
<?php
// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located', 'required' => True], // 区域是必填项 存储空间所在的区域
"endpoint" => ['help' => 'The domain names that other services can use to access OSS', 'required' => False], // 终端节点是可选项 其他服务可以用来访问OSS的域名
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
];
// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
exit(1);
}
}
// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);
// 设置区域
$cfg->setRegion($region);
// 如果提供了终端节点 则设置终端节点
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建获取存储空间生命周期的请求对象
$request = new Oss\Models\GetBucketLifecycleRequest(bucket: $bucket);
// 调用getBucketLifecycle方法获取存储空间的生命周期规则
$result = $client->getBucketLifecycle(request: $request);
// 打印返回结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
'request id:' . $result->requestId . PHP_EOL . // 请求的唯一标识
'lifecycle:' . var_export($result->lifecycleConfiguration, true) . PHP_EOL // 生命周期规则内容
);
清空生命周期规则
以下代码用于清空examplebucket的所有生命周期规则。如果您需要删除其中一条或者多条生命周期规则，请参见如何删除其中一条或多条生命周期规则？。
<?php
// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数描述
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // 区域是必填项 存储空间所在的区域
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 终端节点是可选项 其他服务可以用来访问OSS的域名
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
];
// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
exit(1);
}
}
// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);
// 设置区域
$cfg->setRegion($region);
// 如果提供了终端节点 则设置终端节点
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建删除存储空间生命周期规则的请求对象
$request = new Oss\Models\DeleteBucketLifecycleRequest(bucket: $bucket);
// 调用deleteBucketLifecycle方法删除存储空间的生命周期规则
$result = $client->deleteBucketLifecycle(request: $request);
// 打印返回结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
'request id:' . $result->requestId . PHP_EOL // 请求的唯一标识
);
相关文档
关于设置生命周期规则的API接口说明，请参见PutBucketLifecycle。
关于查看生命周期规则的API接口说明，请参见GetBucketLifecycle。
关于清空生命周期规则的API接口说明，请参见DeleteBucketLifecycle。