对象存储
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 对象存储 > SDK 文档 > Python SDK > 数据管理 > 生命周期

生命周期

最近更新时间：2023-10-27 14:34:21

我的收藏

本页目录：

简介

本文档提供关于生命周期的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
设置生命周期
设置存储桶生命周期管理的配置
查询生命周期
查询存储桶生命周期管理的配置
删除生命周期
删除存储桶生命周期管理的配置

设置生命周期

功能说明

设置指定存储桶的生命周期配置信息（PUT Bucket lifecycle）。

方法原型

put_bucket_lifecycle(Bucket, LifecycleConfiguration={}, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.put_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
    LifecycleConfiguration={
        'Rule': [
            {
                'ID': 'string', # 设置规则的 ID，例如Rule-1
                'Filter': { 
                    'Prefix': '' # 配置前缀为空，桶内所有对象都会执行此规则
                },
                'Status': 'Enabled', # Enabled 表示启用规则
                'Expiration': {
                    'Days': 200 # 设置对象的当前版本200天后过期删除
                },
                'Transition': [
                    {
                        'Days': 100, # 设置对象的当前版本100天后沉降
                        'StorageClass': 'Standard_IA' # 沉降为低频存储
                    },
                ],
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 7 # 设置7天后回收未合并的分块
                }
            }
        ]   
    }
)

全部参数请求示例

from qcloud_cos import get_date
response = client.put_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
    LifecycleConfiguration={
        'Rule': [
            {
                'ID': 'string', # 设置规则的 ID，例如Rule-1
                'Filter': {
                    'Prefix': 'string', # 配置前缀非空，只有符合前缀的对象才会执行此规则
                    'Tag': [ # 配置标签过滤规则，只有标签匹配的对象才会执行此规则，和前缀二选一
                        {
                            'Key': 'string', 
                            'Value': 'string'
                        }
                    ]
                },
                'Status': 'Enabled'|'Disabled', # Enabled 表示启用规则，Disabled 表示不启用，二选一
                'Expiration': { 
                    'Days': 100, # 设置对象的当前版本100天后过期删除
                    'Date': get_date(2021, 4, 20) # 设置对象的当前版本在2021年4月20日之后过期删除，和Days二选一
                },
                'Transition': [
                    {
                        'Days': 60, # 设置对象的当前版本60天后沉降
                        'Date': get_date(2021, 4, 20), # 设置对象的当前版本在2021年4月20日之后沉降，和Days二选一
                        'StorageClass': 'Archive' # 沉降为归档存储
                    },
                ],
                'NoncurrentVersionExpiration': {
                    'NoncurrentDays': 100 # 设置对象的历史版本100天后过期删除
                },
                'NoncurrentVersionTransition': [
                    {
                        'NoncurrentDays': 60, # 设置对象的历史版本60天后沉降
                        'StorageClass': 'Standard_IA' # 沉降为低频存储
                    },
                ],
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 100 # 设置100天后回收未合并的分块
                }
            }
        ]   
    }
)

参数说明

参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
Rule
设置对应的规则，包括 ID，Filter，Status，Expiration，Transition，NoncurrentVersionExpiration，NoncurrentVersionTransition，AbortIncompleteMultipartUpload
List
是
ID
设置规则的 ID
String
否
Filter
用于描述规则影响的 Object 集合，如需设置 Bucket 中的所有 objects，请设置 Prefix 为空''
Dict
是
Status
设置 Rule 是否启用，可选值为 Enabled 或者 Disabled
Dict
是
Expiration
设置 Object 过期规则，可以指定天数 Days 或者指定日期 Date，Date 的格式必须是 GMT ISO 8601，建议使用 get_date 方法来指定具体的日期
Dict
否
Transition
设置 Object 转换存储类型规则，可以指定天数 Days 或者指定日期 Date，Date 的格式必须是 GMT ISO 8601，建议使用 get_date 方法来指定具体的日期。StorageClass 可选 Standard_IA，Archive，Deep_Archive，可以同时设置多条此类规则
List
否
NoncurrentVersionExpiration
设置非当前版本 Object 过期规则，可以指定天数 NoncurrentDays
Dict
否
NoncurrentVersionTransition
设置非当前版本 Object 转换存储类型规则，可以指定天数 NoncurrentDays，StorageClass 可选 Standard_IA，可以同时设置多条此类规则
List
否
AbortIncompleteMultipartUpload
指明分块上传开始后多少天内必须完成上传
Dict
否

返回结果说明

该方法返回值为 None。

查询生命周期

功能说明

查询指定存储桶的生命周期（GET Bucket lifecycle）。

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.get_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
)

参数说明

参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是

返回结果说明

Bucket 生命周期配置，类型为 dict。
{
    'Rule': [
        {
            'ID': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        }
                ]
            },
            'Status': 'string',
            'Expiration': {
                'Days': 100,
                'Date': 'string'
            },
            'Transition': [
                {
                    'Days': 100,
                    'Date': 'string',
                    'StorageClass': 'STANDARD_IA'|'Archive'
                },
            ],
            'NoncurrentVersionExpiration': {
                'NoncurrentDays': 100
            },
            'NoncurrentVersionTransition': [
                {
                    'NoncurrentDays': 100,
                    'StorageClass': 'STANDARD_IA'
                },
            ],
            'AbortIncompleteMultipartUpload': {
                'DaysAfterInitiation': 100
            }
        }
    ]   
}
参数名称
参数描述
类型
Rule
对应的规则，包括 ID，Filter，Status，Expiration，Transition，NoncurrentVersionExpiration，NoncurrentVersionTransition，AbortIncompleteMultipartUpload
List
ID
规则的 ID
String
Filter
用于描述规则影响的 Object 集合
Dict
Status
Rule 是否启用，可选值为 Enabled 或者 Disabled
Dict
Expiration
Object 过期规则，可以指定天数 Days 或者指定日期 Date
Dict
Transition
Object 转换存储类型规则，可以指定天数 Days 或者指定日期 Date，StorageClass 可选 STANDARD_IA，Archive
List
NoncurrentVersionExpiration
非当前版本 Object 过期规则，可以指定天数 NoncurrentDays
Dict
NoncurrentVersionTransition
非当前版本 Object 转换存储类型规则，可以指定天数 NoncurrentDays，StorageClass 可选 STANDARD_IA
List
AbortIncompleteMultipartUpload
分块上传开始后多少天内必须完成上传
Dict

删除生命周期

功能说明

删除指定存储桶的生命周期（DELETE Bucket lifecycle）。

方法原型

delete_bucket_lifecycle(Bucket, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)

response = client.delete_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
)

参数说明

参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是

返回结果说明

该方法返回值为 None。
中国站