GetBucketLifecycle--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

GetBucketLifecycle

最近更新时间：2024.07.16 21:38:28首次发布时间：2023.03.14 21:02:14

功能描述

此接口用于用于获取指定存储桶（Bucket）生命周期规则。

请求消息样式

GET /?lifecycle HTTP/1.1
Host: bucket-name.tos-cn-beijing.volces.com
Date: GMT Date
Authorization: authorization string

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
lifecycle	Query	String	是	-	代表GetBucketLifecycle请求的特殊标识。

请求元素

该请求不使用消息元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

名称	参数类型	示例值	说明
Rules	Array	-	生命周期规则信息。
ID	String	id	规则 ID.
Prefix	String	prefix	规则所适用的前缀（Prefix）.
Status	String	Enabled	是否启用规则。取值说明如下： `Enabled`：表示启用规则，TOS 会定期执行该规则。 `Disabled`：表示不启用规则，TOS 会忽略该规则。
Expiration	Container	{ "Days": 120 }	指定对象的过期属性。对于已开启版本控制的 Bucket，指定的过期时间只对对象的当前版本生效。子节点：Days、Date
Days	Integer	120	指定对象上传后过期删除的天数。父节点：Expiration
Date	String	2024-01-31T00:00:00.000Z	指定对象上传后过期删除的具体日期。按照 ISO8601 标准表示，且为 UTC 的零点。父节点：Expiration
NoncurrentVersionExpiration	Container	-	指定对象历史版本的过期属性。仅对已开启版本控制或暂停版本控制的 Bucket 生效，仅对对象的历史版本生效。子节点：NoncurrentDays、NoCurrentDate
NoncurrentDays	String	30	指定对象历史版本过期删除的天数。父节点：NoncurrentVersionExpiration
NoCurrentDate	String	2024-01-31T00:00:00.000Z	指定对象历史版本过期删除的具体日期。按照 ISO8601 标准表示，且为 UTC 的零点。父节点：NoncurrentVersionExpiration
AbortIncompleteMultipartUpload	Container	-	指定未合并的分片任务（碎片）的过期属性。子节点：DaysAfterInitiation
DaysAfterInitiation	Integer	30	指定未合并的分片任务（碎片）的生命周期规则，在分片任务初始化过后过期删除的天数。父节点：AbortIncompleteMultipartUpload
Transitions	Array	-	指定对象沉降为指定存储类型的过期属性。对于已开启版本控制的 Bucket，指定的过期时间只对对象的当前版本生效。注意如果您同时设置了自动沉降到低频存储、智能分层、归档闪回存储、归档存储、冷归档存储、深度冷归档及删除对象，则沉降时间满足：沉降到低频的时间 < 沉降到智能分层的时间 < 沉降到归档闪回的时间< 沉降到归档的时间 < 沉降到冷归档的时间 < 沉降到深度冷归档的时间 < 删除的时间。子节点：StorageClass、Days、Date
StorageClass	String	IA	指定对象沉降的存储类型。取值如下： `IA`：低频访问存储。 `INTELLIGENT_TIERING`：智能分层存储。 `ARCHIVE_FR`：归档闪回存储。 `ARCHIVE`：归档存储。 `COLD_ARCHIVE`：冷归档存储。 `DEEP_COLD_ARCHIVE`：深度冷归档存储。说明深度冷归档目前处于邀测状态，如您需要使用该存储类型，请联系客户经理。父节点：Transitions
Days	Integer	120	指定对象过期沉降的天数，必须为正整数。父节点：Transitions
Date	String	2024-01-31T00:00:00.000Z	指定对象过期沉降的具体日期。按照 ISO8601 标准表示，且为 UTC 的零点。父节点：Transitions
NoncurrentVersionTransitions	Array	-	指定历史版本对象沉降为指定存储类型的过期属性。仅对已开启版本控制或暂停版本控制的 Bucket 生效，仅对对象的历史版本生效。注意如果您同时设置了将历史版本自动沉降到低频存储、智能分层、归档闪回存储、归档存储、冷归档存储、深度冷归档存储及删除对象，则沉降时间满足：沉降到低频的时间 < 沉降到智能分层的时间 < 沉降到归档闪回的时间< 沉降到归档的时间 < 沉降到冷归档的时间 < 沉降到深度冷归档的时间 < 删除的时间。子节点：StorageClass、NoncurrentDays、NoCurrentDate
StorageClass	String	IA	指定历史版本对象沉降的存储类型。取值如下： `IA`：低频访问存储。 `INTELLIGENT_TIERING`：智能分层存储。 `ARCHIVE_FR`：归档闪回存储。 `ARCHIVE`：归档存储。 `COLD_ARCHIVE`：冷归档存储。 `DEEP_COLD_ARCHIVE`：深度冷归档存储。说明深度冷归档目前处于邀测状态，如您需要使用该存储类型，请联系客户经理。父节点：NoncurrentVersionTransitions
NoncurrentDays	Integer	120	指定历史版本对象过期沉降的天数，必须为正整数。父节点：NoncurrentVersionTransitions
NoncurrentDate	String	2024-01-31T00:00:00.000Z	指定历史版本对象过期沉降的具体日期。按照 ISO8601 标准表示，且为 UTC 的零点。父节点：NoncurrentVersionTransitions
Tags	Array	-	TOS 可针对有特定标签的 Object，配置生命周期规则，最多可配置 10 个标签。关于标签的详细说明，请参见文件标签管理。
Key	String	tag	对象标签的键。父节点：Tags
Value	String	value	对象标签的值。父节点：Tags
Filter	Container	-	指定规则生效的过滤条件，当前支持指定对象大小范围内生效。子节点：ObjectSizeGreaterThan、GreaterThanIncludeEqual、ObjectSizeLessThan、LessThanIncludeEqual
ObjectSizeGreaterThan	Integer	65536	设置规则生效于大于指定大小的对象，单位是字节。父节点：Filter
GreaterThanIncludeEqual	String	Enabled	是否启用相等条件。只能取值 `Enabled` 或 `Disabled`，不配置则默认为 `Disabled`。取值说明如下： `Enabled`：表示启用相等条件，即“大于等于”。 `Disabled`：表示不启用相等条件，即“大于”。父节点：Filter
ObjectSizeLessThan	Integer	65536	设置规则生效于小于指定大小的对象，单位是字节。父节点：Filter
LessThanIncludeEqual	String	Enabled	是否启用相等条件。取值说明如下： `Enabled`：表示启用相等条件，即“小于等于”。 `Disabled`：表示不启用相等条件，即“小于”。父节点：Filter

请求示例

GET /?lifecycle HTTP/1.1
Host: bucket-name.tos-cn-beijing.volces.com
Date: Mon, 14 Apr 2021 01:17:29 GMT  
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
Date: Fri, 30 Jul 2021 13:53:55 GMT
Server: TosServer
x-tos-id-2: 1e89f203jld00006-a444fd0
x-tos-request-id: 1e89f203b2d00006-a444ed0
Content-Length: ***
{
    "Rules": [
        {
            "ID": "id",
            "Prefix": "prefix",
            "Status": "Enabled",
            "Tags": [
                {
                    "Key": "key",
                    "Value": "value"
                }
            ],
            "Filter": {
                "ObjectSizeGreaterThan": 65536,
                "GreaterThanIncludeEqual": "Enabled",
                "ObjectSizeLessThan": 10485760,
                "LessThanIncludeEqual": "Disabled"
            },
            "Expiration": {
                "Days": 120
            },
            "NoncurrentVersionExpiration": {
                "NoncurrentDays": 90
            },
            "AbortIncompleteMultipartUpload": {
                "DaysAfterInitiation": 30
            },
            "Transitions": [
                {
                    "StorageClass": "IA",
                    "Days": 30
                },
                {
                    "StorageClass": "COLD_ARCHIVE",
                    "Days": 60
                }
            ],
            "NoncurrentVersionTransitions": [
                {
                    "StorageClass": "IA",
                    "NoncurrentDays": 30
                },
                {
                    "StorageClass": "COLD_ARCHIVE",
                    "NoncurrentDays": 60
                }
            ]
        }
    ]
}

如果没有设置生命周期规则，则返回示例如下。

{
  "Error": {
    "Code": "NoSuchLifecycleConfiguration",
    "RequestId": "936901f5f9aa32d663f5f9aa-ac192267-1pUn7K-GBL-cq-tos_front",
    "HostId": "fWBVJIQESfYijNMMUzZkucybHUTgEyaF",
    "Message": "The bucket lifecycle configuration does not exist"
  }
}