You need to enable JavaScript to run this app.
导航
对象存储
  • 文档首页
    • /
  • 对象存储

GetBucketLifecycle

最近更新时间：2024.01.15 15:20:45

首次发布时间：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

规则的唯一标识符。

Prefix

String

prefix1/

指定规则所适用的前缀（Prefix）。不支持设置互相包含的 Prefix。

  • 如果指定了 Prefix，则表示此规则仅适用于 Bucket 中与 Prefix 匹配的对象。
  • 如果不设置 Prefix ，则表示此规则适用于 Bucket 中的所有对象。

Status

String

Enabled

是否启用规则。取值说明如下：

  • Enabled：表示启用规则，TOS 会定期执行该规则。
  • Disabled：表示不启用规则，TOS 会忽略该规则。

Expiration

Container

{ "Days": 120 }

指定对象的过期属性。 对于已开启版本控制的 Bucket，指定的过期时间只对对象的当前版本生效。

注意

对象的过期删除时间必须大于转为其他存储类型的时间。

子节点：Days、Date

Days

Integer

120

指定对象上传后失效删除的天数，必须为正整数。

注意

Days 与 Date 参数互斥。

Date

String

2024-01-31T00:00:00.000Z

指定对象上传后失效删除的具体日期。
日期需要按照 ISO8601 标准表示并使用 UTC 时间，且必须为 UTC 的零点。

注意

Days 与 Date 参数互斥。

NoncurrentVersionExpiration

Container

-

指定对象历史版本的过期属性。

NoncurrentDays

String

30

指定对象历史版本过期删除的天数。
父节点：NoncurrentVersionExpiration

AbortIncompleteMultipartUpload

Container

-

指定未合并的分片任务（碎片）的过期属性。

说明

AbortIncompleteMultipartUpload 不支持基于对象标签（Tag）的筛选条件。

DaysAfterInitiation

Integer

10

指定未合并的多段任务（碎片）的生命周期规则，在多段任务初始化过后生效的天数。
父节点：AbortIncompleteMultipartUpload

Transitions

Array

-

指定对象沉降为指定存储类型的天数。

StorageClass

String

IA

指定对象沉降的存储类型。取值如下：

  • IA：低频访问存储。
  • INTELLIGENT_TIERING：智能分层存储。
  • ARCHIVE_FR：归档闪回存储。
  • ARCHIVE：归档存储。
  • COLD_ARCHIVE：冷归档存储。
  • DEEP_COLD_ARCHIVE：深度冷归档存储。

    说明

    深度冷归档目前处于邀测状态，如您需要使用该存储类型，请联系客户经理。

    父节点：Transitions

NoncurrentVersionTransitions

Array

30

指定历史版本对象沉降为指定存储类型的天数。
父节点：Transitions

Tags

Array

-

TOS 可针对有特定标签的 Object，配置生命周期规则，最多可配置 10 个标签。关于标签的详细说明，请参见文件标签管理。

Key

String

tag

对象标签的键。
父节点：Tags

Value

String

value

对象标签的值。
父节点：Tags

请求示例

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": "prefix1/",
      "Status": "Enabled",
      "Expiration": { "Days": 120 },
    },
    {
      "ID": "id",
      "Prefix": "prefix2/",
      "Status": "Enabled",
      "AbortIncompleteMultipartUpload": { "DaysAfterInitiation": 10 }
    }]
}

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

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