# 获取桶ACL(Node.js SDK) #### 功能介绍 访问控制列表（Access Control List，ACL）用于资源拥有者给其他账号授予资源的访问权限。默认情况下，创建存储桶或对象时仅资源拥有者对资源的完全控制权限，即桶创建者对桶拥有完全控制权限，对象上传者对对象拥有完全控制权限，而其他账号默认无权访问资源。如果资源拥有者想授予其他账号资源的读写权限，可以使用ACL实现。OBS桶和对象的ACL是基于账号进行授权，授权后对账号和账号下的IAM用户都生效。 了解更多可参见[ACL权限控制方式介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。 调用获取桶ACL接口，您可以获取指定桶的ACL。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶ACL的权限，才能获取桶ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketAcl权限，如果使用桶策略则需授予GetBucketAcl权限。相关授权方式介绍可参见[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://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。 #### 方法定义 ``` ObsClient.getBucketAcl(params) ``` #### 请求参数 表1BucketRequestInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 长度为3～63个字符。 **默认取值：** 无 | #### 返回结果 表2返回结果 | **参数类型** | **描述** | |:---|:---| | [表3] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表3]。 | 表3Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [表5] | **参数解释：** 操作成功后的结果数据，详见[表5]。 **约束限制：** 当Status大于300时为空。 | 表4ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | 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服务端返回的详细错误码。 | 表5GetBucketAclOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Owner | [Owner] | **参数解释：** 桶的所有者的账号ID，详见[Owner]。 | | Grants | [Grant]\[\] | **参数解释：** 被授权用户权限信息，详见[Grant]。 | 表6Owner | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 作为请求参数时必选 | **参数解释：** 所有者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | DisplayName | string | 可选 | **参数解释：** 所有者的账号用户名。 **默认取值：** 无 | 表7Grant | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Grantee | [Grantee] | **参数解释：** 被授权用户相关信息，详见[Grantee]。 | | Permission | string | **参数解释：** 被授予的权限，详见[PermissionType]。 | 表8Grantee | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Type | string | **参数解释：** 被授权用户的类型，详见[GranteeType]。 | | ID | string | **参数解释：** 被授权用户的账号ID，即domain_id。 | | Name | string | **参数解释：** 被授权用户的账号名。 | | URI | string | **参数解释：** 被授权的用户组，详见[GroupUriType]。 | 表9GranteeType | **常量值** | **说明** | |:---|:---| | Group | 授权给用户组。 | | CanonicalUser | 授权给单个用户。 | 表10GroupUriType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.GroupAllUsers | AllUsers | 所有用户。 | | ObsClient.enums.GroupAuthenticatedUsers | AuthenticatedUsers | 授权用户，已废弃。 | | ObsClient.enums.GroupLogDelivery | LogDelivery | 日志投递组，已废弃。 | 表11PermissionType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.PermissionRead | READ | 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 | | ObsClient.enums.PermissionWrite | WRITE | 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 | | ObsClient.enums.PermissionReadAcp | READ_ACP | 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 | | ObsClient.enums.PermissionWriteAcp | WRITE_ACP | 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 | | ObsClient.enums.PermissionFullControl | FULL_CONTROL | 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。 | #### 代码示例 本示例用于获取名为examplebucket桶的ACL信息。 ``` // 引入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/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.cn-north-4.myhuaweicloud.com", }); async function getBucketAcl() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket" }; // 获取桶ACL const result = await obsClient.getBucketAcl(params); if (result.CommonMsg.Status <= 300) { console.log("Get bucket(%s)'s acl rules successful!", params.Bucket); console.log('RequestId: %s', result.InterfaceResult.RequestId); console.log('Owner[ID]: %s', result.InterfaceResult.Owner.ID); console.log('Grants:'); for (let i = 0; i < result.InterfaceResult.Grants.length; i++) { const grant = result.InterfaceResult.Grants[i]; console.log("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s", i, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission ); }; 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); }; }; getBucketAcl(); ``` #### 相关链接 - 关于获取桶ACL的API说明，请参见[获取桶ACL](https://support.huaweicloud.com/api-obs/obs_04_0031.html)。 - 获取桶ACL过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 权限相关常见问题请参见[权限相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_1100.html)。