# 获取桶的生命周期配置(HarmonyOS SDK) #### 功能说明 OBS支持用户配置指定的规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用，更多生命周期相关信息请参见[生命周期管理](https://support.huaweicloud.com/usermanual-obs/obs_41_0069.html)。 调用获取桶的生命周期配置接口，您可以获取指定桶的生命周期策略。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶的生命周期配置的权限，才能获取桶的生命周配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetLifecycleConfiguration权限，如果使用桶策略则需授予GetLifecycleConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` getBucketLifecycle(input: BucketRequestInput): Response ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [BucketRequestInput] | 必选 | **参数解释：** 获取桶的生命周期规则接口入参，详见 [BucketRequestInput]。 | 表2BucketRequestInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | #### 返回结果 表3返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明： 该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表4Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [GetBucketLifecycleOutput] | **参数解释：** 操作成功后的结果数据，详见[GetBucketLifecycleOutput]。 **约束限制：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6GetBucketLifecycleOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | Rules | [LifecycleRule]\[\] | **参数解释：** 桶生命周期规则列表，详见[LifecycleRule]。 | 表7LifecycleRule | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 作为请求参数时可选 | **参数解释：** 生命周期规则ID。 **取值范围：** 长度大于0且不超过255的字符串。 **默认取值：** 无 | | Prefix | string | 作为请求参数时必选 | **参数解释：** 对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将ExampleObject.jpg指定为前缀，则规则仅应用于该特定对象。如果您将logs/指定为前缀，规则将应用于密钥名称以字符串"logs/"开头的三个对象。如果您指定空的前缀，规则将应用于桶中的所有对象。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | Status | string | 作为请求参数时必选 | **参数解释：** 标识当前规则是否启用。 **取值范围：** Enabled：启用。 Disabled：不启用。 **默认取值：** 无 | | Transitions | [Transition]\[\] | 作为请求参数时可选 | **参数解释：** 对象转换策略列表，用于使用生命周期规则转换对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见[Transition]。 **约束限制：** 仅针对对象的最新版本。 | | Expiration | [Expiration] | 作为请求参数时可选 | **参数解释：** 对象过期时间配置，详见[Expiration]。 **约束限制：** 仅针对对象的最新版本。 | | NoncurrentVersionTransitions | [NoncurrentVersionTransition]\[\] | 作为请求参数时可选 | **参数解释：** 历史版本对象转换策略列表，用于使用生命周期规则转换历史版本对象的存储类别，包含生命周期配置的迁移时间和迁移后对象存储级别，详见[NoncurrentVersionTransition]。 **约束限制：** - 仅针对对象的历史版本。 - 当前桶已启用（或开启后暂停）多版本。 | | NoncurrentVersionExpiration | [NoncurrentVersionExpiration] | 作为请求参数时可选 | **参数解释：** 历史版本对象过期时间配置，详见[NoncurrentVersionExpiration]。 **约束限制：** - 仅针对对象的历史版本。 - 当前桶已启用（或开启后暂停）多版本。 注意： 并行文件系统不支持该参数。 | | AbortIncompleteMultipartUpload | [AbortIncompleteMultipartUpload] | 作为请求参数时可选 | **参数解释：** 未合并的多段任务（碎片）的过期时间配置，详见[AbortIncompleteMultipartUpload]。 **约束限制：** AbortIncompleteMultipartUpload不支持基于标签（Tag）的筛选条件。 | ![](https://support.huaweicloud.com/sdk-harmony-devg-obs/public_sys-resources/note_3.0-zh-cn.png) Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration不能全为空。 表8Transition | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | StorageClass | [StorageClassType] | 作为请求参数时必选 | **参数解释：** 对象转换后的存储类型。 **约束限制：** - 不支持"标准存储"类型。 - 对象存储类别转换限制： - 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。 - 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。 - 仅支持将标准存储、低频访问存储或归档存储对象转换为深度归档存储对象。如果要将深度归档存储对象转换为标准存储、低频访问存储对象或归档存储，需要手动先恢复对象，然后手动转换存储类别。 - 归档和深度归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档或深度归档存储。 **取值范围：** 生命周期转换的目标存储类别取值范围：详见[StorageClassType]。 **默认取值：** 无 | | Date | string | 作为请求参数时，如果没有设置Days则必选 | **参数解释：** 指定OBS对该日期之前的对象执行生命周期规则。 **约束限制：** 日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象转换成其他存储类型，等于或晚于这个时间的对象不会被转换成其他存储类型。 **默认取值：** 无 | | Days | number | 作为请求参数时，如果没有设置Date则必选 | **参数解释：** 指定生命周期规则在对象最后更新过后多少天生效。 **约束限制：** 仅适用于对象的最新版本。 **取值范围：** 0\~（2^31^-1），单位：天 **默认取值：** 无 | 表9Expiration | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Date | string | 作为请求参数时，如果没有设置Days则必选 | **参数解释：** 指定OBS对该日期之前的对象执行生命周期规则，即执行过期删除操作。 **约束限制：** 日期格式必须为ISO8601的格式，并且为UTC的零点。 例如：2018-01-01T00:00:00.000Z，表示将最后修改时间早于2018-01-01T00:00:00.000Z的对象删除，等于或晚于这个时间的对象不会被删除。 **默认取值：** 无 | | Days | number | 作为请求参数时，如果没有设置Date则必选 | **参数解释：** 指定生命周期规则在对象最后更新过后多少天生效，即执行过期删除操作。 **约束限制：** 仅适用于对象的最新版本。 **取值范围：** 1\~（2^31^-1），单位：天 **默认取值：** 无 | 表10NoncurrentVersionTransition | **参数名称** | **参数类型** | **是否可选** | **描述** | |:---|:---|:---|:---| | StorageClass | [StorageClassType] | 作为请求参数时必选 | **参数解释：** 历史版本对象转换后的存储类型。 **约束限制：** - 不支持"标准存储"类型。 - 对象存储类别转换限制： - 仅支持将标准存储对象转换为低频访问存储对象，低频访问存储对象转换为标准存储对象需手动转换。 - 仅支持将标准存储或低频访问存储对象转换为归档存储对象。如果要将归档存储对象转换为标准存储或低频访问存储对象，需要手动先恢复对象，然后手动转换存储类别。 - 仅支持将标准存储、低频访问存储或归档存储对象转换为深度归档存储对象。如果要将深度归档存储对象转换为标准存储、低频访问存储对象或归档存储，需要手动先恢复对象，然后手动转换存储类别。 - 归档和深度归档存储不支持多AZ。因此不支持使用生命周期的存储类别转换功能，将多AZ桶或对象的存储类别转化为归档或深度归档存储。 **取值范围：** 生命周期转换的目标存储类别取值范围：详见[StorageClassType]。 **默认取值：** 无 | | NoncurrentDays | number | 作为请求参数时必选 | **参数解释：** 表示对象在成为历史版本之后第几天时规则生效。 **约束限制：** 仅适用于历史版本。 **取值范围：** 0\~（2^31^-1），单位：天 **默认取值：** 无 | 表11NoncurrentVersionExpiration | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | NoncurrentDays | number | 作为请求参数时必选 | **参数解释：** 表示对象在成为历史版本之后第几天时规则生效。 **约束限制：** 仅针对历史版本。 **取值范围：** 0\~（2^31^-1），单位：天 **默认取值：** 无 | 表12AbortIncompleteMultipartUpload | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | DaysAfterInitiation | number | 作为请求参数时必选 | **参数解释：** 指定未合并的多段任务（碎片）的生命周期规则，在多段任务初始化过后多少天生效。 **取值范围：** 0\~（2^31^-1），单位：天 **默认取值：** 无 | 表13StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。 适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 代码示例 本示例用于获取名为examplebucket桶的生命周期规则。 ``` // 引入依赖包 import ObsClient, { BucketRequestInput } from '@obs/esdk-obs-harmony'; import { process } from '@kit.ArkTS'; import { BusinessError } from '@kit.BasicServicesKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; const processManager = new process.ProcessManager(); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"), SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"), // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"), // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getBucketLifecycle() { try { const params: BucketRequestInput = { // 指定存储桶名称 Bucket: "examplebucket" }; // 获取桶的生命周期规则 const result = await obsClient.getBucketLifecycle(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Get bucket(%s)'s lifecycle configuration successful!", params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); for (let i = 0; i < result.InterfaceResult.Rules.length; i++) { const rule = result.InterfaceResult.Rules[i]; hilog.info(0x0001, 'OBS-Harmony', "ID:%s, Prefix:%s, Status:%s, Expiration[Date]:%s, Expiration[Days]:%d, NoncurrentVersionExpiration[NoncurrentDays]:%s", rule.ID, rule.Prefix, rule.Status, rule.Expiration?.Date, rule.Expiration?.Days, rule.NoncurrentVersionExpiration?.NoncurrentDays ); } return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response."); hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } getBucketLifecycle(); ``` #### 相关链接 - 关于获取桶的生命周期配置的API说明，请参见[获取桶的生命周期配置](https://support.huaweicloud.com/api-obs/obs_04_0035.html)。 - 获取桶的生命周期配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 生命周期管理相关问题请参见[生命周期管理相关问题](https://support.huaweicloud.com/usermanual-obs/obs_03_0335.html)。