查看桶多版本状态(Node.js SDK)

开发过程中，您有任何问题可以在github上提交issue。

功能介绍

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

调用获取桶的多版本状态接口，您可以获取指定桶的多版本状态。

接口约束

您必须是桶拥有者或拥有获取桶的多版本状态的权限，才能获取桶的多版本状态。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketVersioning权限，如果使用桶策略则需授予GetBucketVersioning权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.getBucketVersioning(params)

请求参数

表1 BucketRequestInput
参数名称	参数类型	是否必选	描述
Bucket	string	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。取值范围：长度为3～63个字符。默认取值：无

返回结果

表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 GetBucketVersioningOutput
参数名称	参数类型	描述
RequestId	string	参数解释： OBS服务端返回的请求ID。
VersionStatus	string	参数解释：桶的多版本状态。

代码示例

您可以通过ObsClient.getBucketVersioning查看桶的多版本状态。以下代码展示了如何查看名为examplebucket桶的多版本状态。

    
     
       
       
         // 引入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/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
});

async function getBucketVersioning() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
    };
    // 获取桶的多版本状态
    const result = await obsClient.getBucketVersioning(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s versioning status successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log('VersionStatus: %s', result.InterfaceResult.VersionStatus);
      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);
  };
};

getBucketVersioning();

        

      

    
   