接口介绍
设置Bucket的生命周期规则。
接口约束
支持的线上资源池 :上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
POST /v4/oss/put-bucket-lifecycle-conf
请求参数
请求体 JSON Body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
bucket | 是 | String | 桶名 | bucket1 |
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
lifecycleConfiguration | 是 | Object | 生命周期配置 | 见下级对象 |
表 lifecycleConfiguration
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
rules | 是 | Array of Objects | 生命周期规则 | 见下级对象 |
表 rules
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
ID | 否 | String | 规则ID | rule1 |
expiration | 否 | Object | 用日期或天数指定对象的过期时间。若未传此参数,则参数 transitions、noncurrentVersionExpiration、noncurrentVersionTransitions 至少指定其中一个 | 2022-10-18T00:00:00Z |
status | 是 | String | 规则是否启用,值为 Enabled 或 Disabled | Enabled |
noncurrentVersionExpiration | 否 | Object | 标识历史版本的过期规则。若未传此参数,则参数 expiration、transitions、noncurrentVersionTransitions 至少指定其中一个 | 2022-10-18T00:00:00Z |
noncurrentVersionTransitions | 否 | Array of Objects | 标识历史版本的转存储规则。若未传此参数,则参数 expiration、transitions、noncurrentVersionExpiration 至少指定其中一个 | 见下级对象 |
filter | 否 | Object | 过滤应用规则的对象。一个filter必须有Prefix、Tag或And中的一个指定或者 filter 为空 {}。若未传此参数,则需要指定 prefix 参数 | 见下级对象 |
prefix | 否 | String | 识别规则所适用的一个或多个对象的前缀,若未传此参数,需要指定 filter 参数。若此参数与 filter 参数中的 prefix 同时存在,则 filter 中的 prefix 参数生效 | nn_ |
abortIncompleteMultipartUpload | 否 | Object | 指定自不完整的多部分上传开始后,在自动永久删除上传的所有部分之前将等待的天数 | 见下级对象 |
transitions | 否 | Array of Objects | 指定桶内对象何时过渡到指定的存储类别。若未传此参数,则参数 expiration、noncurrentVersionExpiration、noncurrentVersionTransitions 至少指定其中一个 | 见下级对象 |
表 expiration
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
date | 否 | String | ISO-8601 格式的日期字符串,精确到天。表示对象在什么日期被移动或删除。且与参数 expiredObjectDeleteMarker 以及 days 不能共存 | 2022-10-18T00:00:00Z |
expiredObjectDeleteMarker | 否 | Boolean | 指定是否自动移除过期删除标记。如果设置为true,删除标记将过期;如果设置为 false,则策略不执行任何操作。且与参数 date 以及 days 不能共存 | false |
days | 否 | Integer | 表示受该规则约束的对象的寿命,以天为单位。该值必须是一个非零的正整数。且与参数 date 以及 expiredObjectDeleteMarker 不能共存 | 22 |
表 noncurrentVersionExpiration
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
noncurrentDays | 是 | Integer | 指定对象在ZOS可以执行关联操作之前处于非当前状态的天数。该值必须是一个非零的正整数 | 123 |
表 noncurrentVersionTransitions
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
noncurrentDays | 是 | Integer | 指定对象在ZOS可以执行关联操作之前处于非当前状态的天数 | 123 |
storageClass | 是 | String | 用于存储对象的存储类。仅限于 GLACIER, STANDARD_IA | STANDARD_IA |
表 filter
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
and | 否 | Object | 这在生命周期规则过滤器中用于将逻辑 AND 应用于两个或多个谓词。生命周期规则将应用于与 And 运算符中配置的所有谓词匹配的任何对象。若要同时使用 prefix, tag 参数,请使用此参数。 | 见下级对象 |
prefix | 否 | String | 标识规则适用的一个或多个对象的前缀。若要与 tag 参数一起使用,请使用 and 参数 | ss_ |
tag | 否 | Object | 这个标签必须存在于对象的标签集中,以便规则的应用。若要与 prefix 参数一起使用,请使用 and 参数 | 见下级对象 |
表 and
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
prefix | 否 | String | 标识规则适用的一个或多个对象的前缀 | cc_ |
tags | 否 | Array of Objects | 所有这些标签都必须存在于对象的标签集中,才能应用规则 | 见下级对象 |
表 tags
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
key | 是 | String | 对象名称 | key2 |
value | 是 | String | 标签值 | value2 |
表 tag
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
key | 是 | String | 对象名称 | key1 |
value | 是 | String | 标签值 | value1 |
表 abortIncompleteMultipartUpload
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
daysAfterInitiation | 是 | Integer | 指定ZOS中止未完成分段上传的天数。 | 123 |
表 transitions
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
date | 否 | String | 指示对象何时转换到指定的存储类,与 days 不能共存。日期值为 ISO 8601 格式,精确到天 | 2022-10-18T00:00:00Z |
days | 否 | Integer | 指示对象在创建后转换到指定存储类的天数,与 date 不能共存。该值必须是正整数 | 123 |
storageClass | 是 | String | 该对象过渡到的存储类,可选值为 GLACIER, STANDARD_IA | GLACIER |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
请求示例
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"lifecycleConfiguration": {
"rules": [
{
"status": "Enabled",
"noncurrentVersionExpiration": {
"noncurrentDays": 123
},
"noncurrentVersionTransitions": [
{
"noncurrentDays": 123,
"storageClass": "STANDARD_IA"
}
],
"filter": {
"and": {
"prefix": "cc_",
"tags": [
{
"key": "key2",
"value": "value2"
}
]
}
},
"expiration": {
"date": "2022-10-18T00:00:00Z"
},
"abortIncompleteMultipartUpload": {
"daysAfterInitiation": 123
},
"transitions": [
{
"date": "2022-10-18T00:00:00Z",
"storageClass": "GLACIER"
}
],
"ID": "string"
}
]
}
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表