文档首页/ 对象存储服务 OBS/ SDK参考/ Node.js/ 标签管理(Node.js SDK)/ 设置桶标签(Node.js SDK)
更新时间：2024-11-13 GMT+08:00
查看PDF
分享

设置桶标签(Node.js SDK)

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

功能介绍

为桶添加标签后，该桶上所有请求产生的计费话单里都会带上这些标签，从而可以针对话单报表做分类筛选，进行更详细的成本分析。例如：某个应用程序在运行过程会往桶里上传数据，我们可以用应用名称作为标签，设置到被使用的桶上。在分析话单时，就可以通过应用名的标签来分析此应用的成本。

调用设置桶标签接口，您可为指定桶添加标签。

更多关于桶标签的内容请参考桶标签。

接口约束

  • 每个桶最多能设置10个标签。
  • 标签的键名（Key）的最大长度为36个字符，标签的键值（Value）的最大长度为43个字符。
  • 标签的键名（Key）和键值（Value）不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ASCII码0x00--0x1F这些控制字符。
  • 您必须是桶拥有者或拥有设置桶标签的权限，才能设置桶标签。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketTagging权限，如果使用桶策略则需授予PutBucketTagging权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketTagging(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

string

必选

桶名。

约束限制：

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

取值范围：

长度为3～63个字符。

默认取值：

无

Tags

Tag[]

必选

参数解释：

桶标签列表。

约束限制：

  • 一个桶默认最大拥有10个标签。每个标签有且只有一对键值。
  • 同一个桶标签的键不能重复，但是值可以重复，并且可以为空。

取值范围：

详见Tag。

默认取值：

无
表2 Tag

参数名称

参数类型

是否必选

描述

Key

string

作为请求参数时必选

参数解释：

标签的键。

约束限制：

  • 同一个桶标签的键不能重复。
  • 可以自定义，也可以选择预先在标签管理服务（TMS）创建好的标签。
  • 长度范围为1到36个字符。
  • 不能以空格开头或结尾，不能包含非打印字ASCII（0-31）、“=”、“*”、“<”、“>”、“\”。
  • 区分大小写。

取值范围：

长度为1到36个字符。

默认取值：

无

Value

string

作为请求参数时必选

参数解释：

标签的值。

约束限制：

标签的值可以重复，并且可以为空。

  • 长度范围为0到43个字符。
  • 不能包含非打印字ASCII（0-31）、“=”、“*”、“<”、“>”、“\”。
  • 区分大小写。

取值范围：

长度为0到43个字符。

默认取值：

无

返回结果

表3 返回结果

参数类型

描述

表4

说明：

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

参数解释：

接口返回信息，详见表4。
表4 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释：

接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。

InterfaceResult

表6

参数解释：

操作成功后的结果数据，详见表6。

约束限制：

当Status大于300时为空。
表5 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服务端返回的详细错误码。
表6 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释：

OBS服务端返回的请求ID。

代码示例

以下代码展示了如何设置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
45
46
47
48
 
// 引入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 setBucketTagging() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定桶的标签
      Tags: [
        {Key: "key0", Value: "value0"},
        {Key: "key1", Value: "value1"},
      ]
    };
    // 设置桶标签配置
    const result = await obsClient.setBucketTagging(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set bucket(%s)'s tagging configuration 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);
  };
};

setBucketTagging();