# 获取桶ACL(Java SDK) #### 功能介绍 访问控制列表（Access Control List，ACL）用于资源拥有者给其他账号授予资源的访问权限。默认情况下，创建存储桶或对象时仅资源拥有者对资源的完全控制权限，即桶创建者对桶拥有完全控制权限，对象上传者对对象拥有完全控制权限，而其他账号默认无权访问资源。如果资源拥有者想授予其他账号资源的读写权限，可以使用ACL实现。OBS桶和对象的ACL是基于账号进行授权，授权后对账号和账号下的IAM用户都生效。 了解更多可参见[ACL权限控制方式介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。 调用获取桶ACL接口，您可以获取指定桶的ACL。 ![](https://support.huaweicloud.com/sdk-java-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在Github上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-java-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 #### 接口约束 - 您必须是桶拥有者或拥有获取桶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以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 obsClient.getBucketAcl(String [bucketName]) #### 获取桶ACL请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucketName | String | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | #### 返回结果说明 表2AccessControlList | **参数名称** | **参数类型** | **是否必选** | **参数类型** | |:---|:---|:---|:---| | owner | [Owner] | 必选 | **参数解释** **：** 桶所有者的信息，详见[Owner]。 | | delivered | boolean | 可选 | **参数解释：** 桶的ACL是否向桶内对象传递，作用于桶内所有对象。 **取值范围：** true：是，桶ACL向桶内对象传递。 false：否，桶ACL不向桶内对象传递，仅作用于桶。 **默认取值：** false | | grants | Set\<[GrantAndPermission]\> | 可选 | **参数解释：** 被授权用户相关信息，详见[GrantAndPermission]。 | 表3Owner | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | id | String | 必选 | **参数解释**： 桶所有者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID?](https://support.huaweicloud.com/sdk-java-devg-obs/obs_23_1712.html) **默认取值：** 无 | | displayName | String | 可选 | **参数解释：** 所有者的账号名。 **取值范围：** 如何获取账号名请参见[如何获取账号名?](https://support.huaweicloud.com/sdk-java-devg-obs/obs_23_1712.html) **默认取值：** 无 | 表4GrantAndPermission | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | grantee | [CanonicalGrantee]或[GroupGrantee] | 必选 | **参数解释：** 被授权用户或用户组。 **取值范围：** 被授权用户的用户信息，详见[CanonicalGrantee]。 被授权用户组的用户组信息，详见[GroupGrantee]。 | | permission | [Permission] | 必选 | **参数解释：** 用户或用户组被授予的权限。 **取值范围：** 详见[Permission]。 **默认取值：** 无 | | delivered | boolean | 可选 | **参数解释：** 桶的ACL是否向桶内对象传递，作用于桶内所有对象。 **取值范围：** true：是，桶ACL向桶内对象传递。 false：否，桶ACL不向桶内对象传递，仅作用于桶。 **默认取值：** false | 表5CanonicalGrantee | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | grantId | String | 如果Type为用户类型则必选 | **参数解释：** 被授权用户的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID?](https://support.huaweicloud.com/sdk-java-devg-obs/obs_23_1712.html)。 **默认取值：** 无 | | displayName | String | 可选 | **参数解释：** 被授权用户的账号名。 **取值范围：** 如何获取账号名请参见[如何获取账号名?](https://support.huaweicloud.com/sdk-java-devg-obs/obs_23_1712.html)。 **默认取值：** 无 | 表6GroupGrantee | **常量名** | **说明** | |:---|:---| | ALL_USERS | 所有用户。 | | AUTHENTICATED_USERS | 授权用户，已废弃。 | | LOG_DELIVERY | 日志投递组，已废弃。 | 表7Permission | **常量名** | **原始值** | **说明** | |:---|:---|:---| | PERMISSION_READ | READ | 读权限。 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 | | PERMISSION_WRITE | WRITE | 写权限。 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 | | PERMISSION_READ_ACP | READ_ACP | 读取ACL配置的权限。 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 | | PERMISSION_WRITE_ACP | WRITE_ACP | 修改ACL配置的权限。 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 | | PERMISSION_FULL_CONTROL | FULL_CONTROL | 完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。 如果有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。 如果有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。 | #### 代码示例 本示例用于获取examplebucket桶的桶ACL。 ``` import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.AccessControlList; public class GetBucketAcl001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk, endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { //示例桶名 String exampleBucket = "examplebucket"; //获取桶ACL AccessControlList acl = obsClient.getBucketAcl(exampleBucket); System.out.println("GetBucketAcl successfully"); System.out.println(acl); } catch (ObsException e) { System.out.println("GetBucketAcl failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("GetBucketAcl failed"); // 其他异常信息打印 e.printStackTrace(); } } } ``` #### 相关链接 - 关于获取桶ACL的API说明，请参见[获取桶ACL](https://support.huaweicloud.com/api-obs/obs_04_0031.html)。 - 更多关于桶ACL的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-java-obs/blob/master/app/src/test/java/samples_java/BucketOperationsSample.java)。 - 获取桶ACL过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 权限相关常见问题请参见[权限相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_1100.html)。