配置对象级WORM保护策略(Node.js SDK)
功能介绍
开启了WORM开关的桶,上传的对象支持配置或修改对象保护期限。
- 如果上传对象时没有配置保护期限或自动应用桶级默认保护策略,您可以通过该操作配置对象保护期限。
- 如果上传对象时配置了保护期限或自动应用了默认保护期限,允许用户通过该操作延长保护期限。
- 对象保护期限仅允许修改,不允许删除。
接口约束
- 您必须是桶拥有者或拥有配置对象级WORM保护策略的权限,才能调用本接口。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObjectRetention权限,如果使用桶策略则需授予PutObjectRetention权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.setObjectRetention(params)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | string | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| Key | string | 必选 | 参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
| VersionId | string | 可选 | 参数解释: 对象的版本号。例如:G001117FCE89978B0000401205D5DC9。 取值范围: 长度为32的字符串。 默认取值: 无,如果不设置则默认指定最新版本的对象。 |
| Mode | string | 必选 | 参数解释: 对象的WORM保护策略。 约束限制: 不涉及 取值范围: COMPLIANCE:合规模式。 默认取值: 无 |
| RetainUntilDate | number | 必选 | 参数解释: 对象的保护期限。 示例:1435728035000。 约束限制:
取值范围: 必须晚于当前时间。 默认取值: 无 |
返回结果
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| CommonMsg | 参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见表4。 | |
| InterfaceResult | 参数解释: 操作成功后的结果数据,详见表5。 约束限制: 当Status大于300时为空。 |
| 参数名称 | 参数类型 | 描述 |
| Status | number | 参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
| Code | string | 参数解释: OBS服务端返回的错误码。 |
| Message | string | 参数解释: OBS服务端返回的错误描述。 |
| HostId | string | 参数解释: OBS服务端返回的请求服务端ID。 |
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 |
| Id2 | string | 参数解释: OBS服务端返回的请求ID2。 |
| Indicator | string | 参数解释: OBS服务端返回的详细错误码。 |
代码示例
您可以通过ObsClient.setObjectRetention配置对象级WORM保护策略。代码示例如下:
// 引入obs库
// 使用npm安装
const ObsClient = require("esdk-obs-nodejs");
// 使用源码安装
// var ObsClient = require('./lib/obs');
// 创建ObsClient实例
const obsClient = new ObsClient({
// 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id: process.env.ACCESS_KEY_ID,
secret_access_key: process.env.SECRET_ACCESS_KEY,
// 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
// security_token: process.env.SECURITY_TOKEN,
// endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
server: "https://obs.cn-north-4.myhuaweicloud.com",
});
async function setObjectRetention() {
try {
// 计算保留到期时间:当前时间 + 30天(毫秒时间戳)
const retainUntilDate = Date.now() + 30 * 24 * 60 * 60 * 1000;
const params = {
// 指定存储桶名称
Bucket: "examplebucket",
// 指定对象名
Key: "objectname.txt",
// 指定保留模式
Mode: "COMPLIANCE",
// 指定保留到期时间
RetainUntilDate: retainUntilDate,
};
// 配置对象级WORM保护策略
const result = await obsClient.setObjectRetention(params);
if (result.CommonMsg.Status <= 300) {
console.log("Set object retention successful!\n");
console.log("RequestId: %s", result.CommonMsg.RequestId);
return;
};
console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
console.log("Status: %d", result.CommonMsg.Status);
console.log("Code: %s", result.CommonMsg.Code);
console.log("Message: %s", result.CommonMsg.Message);
console.log("RequestId: %s", result.CommonMsg.RequestId);
} catch (error) {
console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
console.log(error);
};
};
setObjectRetention();