获取桶存储类别(Node.js SDK)
功能介绍
调用获取桶存储类别接口,可获取指定桶的存储类别。
接口约束
- 您必须是桶拥有者或拥有获取桶存储类别的权限,才能获取桶存储类别。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketStoragePolicy权限,如果使用桶策略则需授予GetBucketStoragePolicy权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketStoragePolicy(params)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 桶名。 约束限制:
取值范围: 长度为3~63个字符。 默认取值: 无 |
返回结果
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见GetBucketMetadataOutput。 约束限制: 当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服务端返回的详细错误码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 |
StorageClass |
参数解释: 桶的存储类别。 取值范围: 存储类别取值详见StorageClassType。 |
常量名 |
原始值 |
说明 |
---|---|---|
ObsClient.enums.StorageClassStandard |
STANDARD |
标准存储。 标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。 |
ObsClient.enums.StorageClassWarm |
WARM |
低频访问存储。 低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。 |
ObsClient.enums.StorageClassCold |
COLD |
归档存储。 归档存储适用于很少访问(平均一年访问一次)数据的业务场景。 |
代码示例
您可以通过ObsClient.getBucketStoragePolicy获取桶存储类别。以下代码展示如何获取名为examplebucket桶的存储类别。
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 |
// 引入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 getBucketStoragePolicy() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket" }; // 获取桶的存储类别 const result = await obsClient.getBucketStoragePolicy(params); if (result.CommonMsg.Status <= 300) { console.log("Get bucket(%s)'s storage-class successful!", params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); console.log('StorageClass: %s', result.InterfaceResult.StorageClass); 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); }; }; getBucketStoragePolicy(); |
相关链接
- 关于获取桶存储类别的API说明,请参见获取桶存储类型。
- 获取桶存储类别过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 桶和对象相关常见问题请参见桶和对象相关常见问题。