九游平台/ 对象存储服务 obs/ sdk参考/ node.js/ / 设置桶多版本状态(node.js sdk)
更新时间:2024-11-05 gmt 08:00

设置桶多版本状态(node.js sdk)-九游平台

开发过程中,您有任何问题可以在github上,或者在中发帖求助。

功能介绍

obs支持多版本控制,您可以在一个桶中保留对象的多个版本,使您更方便地检索和还原各个版本,在意外操作或应用程序故障时快速恢复数据。更多多版本相关信息请参见多版本控制

调用设置桶的多版本状态接口,您可以为指定桶设置多版本状态。

接口约束

  • 您必须是桶拥有者或拥有设置桶的多版本状态的权限,才能设置桶的多版本状态。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:putbucketversioning权限,如果使用桶策略则需授予putbucketversioning权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
  • obs支持的region与endpoint的对应关系,详细信息请参见。

方法定义

obsclient.setbucketversioning(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucket

string

必选

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用ip地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

取值范围:

长度为3~63个字符。

默认取值:

versionstatus

string

必选

参数解释

桶的多版本状态。

约束限制:

取值范围:

桶的多版本状态,支持的值:

  • enabled:启用
  • suspended:暂停

默认取值:

返回结果

表2 返回结果

参数类型

描述

表3

说明:

该接口返回是一个promise类型,需要使用promise、async/await语法处理。

参数解释:

接口返回信息,详见

表3

表3 response

参数名称

参数类型

描述

commonmsg

icommonmsg

参数解释:

接口调用完成后的公共信息,包含http状态码,操作失败的错误码等,详见icommonmsg

interfaceresult

表5

参数解释:

操作成功后的结果数据,详见表5

约束限制

当status大于300时为空。

表4 icommonmsg

参数名称

参数类型

描述

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服务端返回的详细错误码。

表5 baseresponseoutput

参数名称

参数类型

描述

requestid

string

参数解释:

obs服务端返回的请求id。

代码示例

本示例用于如何设置桶的多版本状态。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// 引入obs库
// 使用npm安装
constobsclient=require("esdk-obs-nodejs");
// 使用源码安装
// var obsclient = require('./lib/obs');
// 创建obsclient实例
constobsclient=newobsclient({
// 推荐通过环境变量获取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",
});
asyncfunctionsetbucketversioning(){
try{
constparams={
// 指定存储桶名称
bucket:"examplebucket",
// 指定桶的版本状态,此处以 enabled 为例
versionstatus:'enabled'
};
// 设置桶的多版本状态
constresult=awaitobsclient.setbucketversioning(params);
if(result.commonmsg.status<=300){
console.log("set bucket(%s)'s versioning status successful!",params.bucket);
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);
};
};
setbucketversioning();

相关文档

网站地图