# 获取桶标签(HarmonyOS SDK) #### 功能说明 为桶添加标签后，该桶上所有请求产生的计费话单里都会带上这些标签，从而可以针对话单报表做分类筛选，进行更详细的成本分析。例如：某个应用程序在运行过程会往桶里上传数据，我们可以用应用名称作为标签，设置到被使用的桶上。在分析话单时，就可以通过应用名的标签来分析此应用的成本。 调用获取桶标签接口，您可获取指定桶的标签。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶标签的权限，才能获取桶标签。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketTagging权限，如果使用桶策略则需授予GetBucketTagging权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` getBucketTagging(input: BucketRequestInput): Response ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [BucketRequestInput] | 必选 | **参数解释：** 获取桶标签接口入参，详见[BucketRequestInput]。 | 表2BucketRequestInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | #### 返回结果 表3返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明： 该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表4Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [GetBucketTaggingOutput] | **参数解释：** 操作成功后的结果数据，详见[GetBucketTaggingOutput]。 **约束限制：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6GetBucketTaggingOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | Tags | [Tag]\[\] | **参数解释：** 桶标签列表，详见[Tag]。 **约束限制：** - 一个桶默认最大拥有10个标签。每个标签有且只有一对键值。 - 同一个桶标签的键不能重复，但是值可以重复，并且可以为空。 | 表7Tag | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Key | string | 作为请求参数时必选 | **参数解释：** 标签的键。 **约束限制：** - 同一个桶标签的键不能重复。 - 可以自定义，也可以选择预先在标签管理服务（TMS）创建好的标签。 - 长度范围为1到128个字符。 - 不能以空格开头或结尾，不能包含字符","、"\*"、"\|"、"/"、"\<"、"\>"、"="、"\\"以及ASCII码0x00--0x1F的控制字符，在发送到服务器之前，必须将键名（Key）和键值（Value）进行UrlEncode编码。 - 区分大小写。 **默认取值：** 无 | | Value | string | 作为请求参数时必选 | **参数解释：** 标签的值。 **约束限制：** 标签的值可以重复，并且可以为空。 - 长度范围为0到255个字符。 - 不能以空格开头或结尾，不能包含字符","、"\*"、"\|"、"/"、"\<"、"\>"、"="、"\\"以及ASCII码0x00--0x1F的控制字符，在发送到服务器之前，必须将键名（Key）和键值（Value）进行UrlEncode编码。 - 区分大小写。 **默认取值：** 无 | #### 代码示例 本示例用于获取名为examplebucket桶的标签配置。 ``` // 引入依赖包 import ObsClient, { BucketRequestInput } from '@obs/esdk-obs-harmony'; import { process } from '@kit.ArkTS'; import { BusinessError } from '@kit.BasicServicesKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; const processManager = new process.ProcessManager(); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"), SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"), // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"), // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function getBucketTagging() { try { const params: BucketRequestInput = { // 指定存储桶名称 Bucket: "examplebucket" }; // 获取桶标签配置 const result = await obsClient.getBucketTagging(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Get bucket(%s)'s tagging configuration successful!", params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); for (let tag of result.InterfaceResult.Tags) { hilog.info(0x0001, 'OBS-Harmony', 'Key: %s, Value: %s', tag.Key, tag.Value); } return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response."); hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } getBucketTagging(); ``` #### 相关链接 - 关于获取桶标签的API说明，请参见[获取桶标签](https://support.huaweicloud.com/api-obs/obs_04_0050.html)。 - 获取桶标签过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 标签相关常见问题请参见[标签相关常见问题](https://support.huaweicloud.com/usermanual-obs/obs_03_0331.html)。