# 获取桶元数据(HarmonyOS SDK) #### 功能说明 调用获取桶元数据接口，可获取指定桶的相关信息，包括指定桶的存储类型、区域位置、跨域资源共享（CORS）规则、冗余策略等信息。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶元数据的权限，才能获取桶元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:HeadBucket权限，如果使用桶策略则需授予HeadBucket权限。相关授权方式介绍可参见[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)。 #### 方法定义 ``` getBucketMetadata(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 | [GetBucketMetadataOutput] | **参数解释：** 操作成功后的结果数据，详见[GetBucketMetadataOutput]。 **约束限制：** 当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服务端返回的详细错误码。 | 表6GetBucketMetadataOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | StorageClass | [StorageClassType] | **参数解释** **：** 桶的存储类型，详情参见[StorageClassType]。 **取值范围：** 当桶存储类型是标准存储时，该值为空。 | | Location | string | **参数解释** **：** 桶所在的区域。 **约束限制：** 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 **取值范围：** 当前有效的OBS区域和终端节点的更多信息，请参考[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 **默认取值：** 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。 | | ObsVersion | string | **参数解释：** 桶所在的OBS服务版本号。 **取值范围：** - "3.0"表示最新版本的桶。 - "--"表示老版本的桶。 **默认取值：** 无 | | AllowOrigin | string | **参数解释：** 如果请求中的Origin满足桶的CORS规则，则返回CORS规则中的AllowedOrigin。AllowedOrigin指定允许的跨域请求的来源，即允许来自该域名下的请求访问该对象。 **约束限制：** 表示域名的字符串，每个匹配规则允许使用最多一个"\*"通配符。例如：https://\*.obs.example.com。 **默认取值：** 无 | | AllowHeader | string | **参数解释：** 如果请求的RequestHeader满足桶的CORS规则，则返回CORS规则中的AllowedHeader。AllowedHeader是指允许的跨域请求的头域。只有匹配上允许的头域中的配置，才被视为是合法的CORS请求。 **约束限制：** 最多可填写一个"\*"通配符，不支持\&、:、\<、空格以及中文字符。 **默认取值：** 无 | | AllowMethod | string | **参数解释：** 桶CORS规则中的AllowedMethod。AllowedMethod指允许的跨域请求HTTP方法，即桶和对象的几种操作类型。 **取值范围：** 支持以下HTTP方法： - GET - PUT - HEAD - POST - DELETE **默认取值：** 无 | | ExposeHeader | string | **参数解释：** 桶CORS规则中的ExposeHeader。ExposeHeader是指CORS规则允许响应中可返回的附加头域，给客户端提供额外的信息。默认情况下浏览器只能访问以下头域：Content-Length、Content-Type，如果需要访问其他头域，需要在附加头域中配置。 **约束限制：** 不支持\*、\&、:、\<、空格以及中文字符。 **默认取值：** 无 | | MaxAgeSeconds | number | **参数解释：** 桶CORS规则中的MaxAgeSeconds。MaxAgeSeconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。 **约束限制：** 每个CORSRule可以包含至多一个MaxAgeSeconds。 **取值范围：** 0\~（2^31^-1），单位：秒。 **默认取值：** 100，单位：秒。 | | MultiEnterprise | string | **参数解释** **：** 创桶时可指定的企业项目ID，开通企业项目的用户可以从企业项目服务获取。 **约束限制：** MultiEnterprise格式为uuid，未开通企业项目的用户可以不带该头域。 示例：9892d768-2d13-450f-aac7-ed0e44c2585f **取值范围：** 如何获取企业项目ID参见[如何获取企业项目ID](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html) 。 **默认取值：** 无 | | AzRedundancy | string | 可选 **参数解释** **：** 创桶时可指定的数据冗余类型，即AZ类型。 **约束限制：** 归档和深度归档存储不支持多AZ。如果桶所在区域如果不支持多AZ存储，则该桶的存储类型默认为单AZ。 **取值范围：** 如果将桶配置为多AZ，则取值为3az。如果将桶配置为单AZ，则无需选择此选项，系统默认赋值。 **默认取值：** 单AZ | 表7StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。 适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 代码示例 本示例用于获取名为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 getBucketMetadata() { try { const params: BucketRequestInput = { // 指定存储桶名称 Bucket: "examplebucket" }; // 获取桶元数据信息 const result = await obsClient.getBucketMetadata(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Get bucket(%s)'s metadata successful!", params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); hilog.info(0x0001, 'OBS-Harmony', 'StorageClass: %s', result.InterfaceResult.StorageClass); hilog.info(0x0001, 'OBS-Harmony', 'Location: %s', result.InterfaceResult.Location); hilog.info(0x0001, 'OBS-Harmony', 'AzRedundancy: %s', result.InterfaceResult.AzRedundancy); hilog.info(0x0001, 'OBS-Harmony', 'MultiEnterprise: %s', result.InterfaceResult.MultiEnterprise); 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); } } getBucketMetadata(); ``` #### 相关链接 - 关于获取桶元数据的API说明，请参见[获取桶元数据](https://support.huaweicloud.com/api-obs/obs_04_0023.html)。 - 获取桶元数据过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 桶和对象相关常见问题请参见[桶和对象相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_1200.html)。