# 设置对象ACL(Go SDK) #### 功能说明 访问控制列表（Access Control List，ACL）用于资源拥有者给其他账号授予资源的访问权限。默认情况下，创建存储桶或对象时仅资源拥有者对资源的完全控制权限，即桶创建者对桶拥有完全控制权限，对象上传者对对象拥有完全控制权限，而其他账号默认无权访问资源。如果资源拥有者想授予其他账号资源的读写权限，可以使用ACL实现。OBS桶和对象的ACL是基于账号进行授权，授权后对账号和账号下的IAM用户都生效。了解更多可参见[ACL权限控制方式介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。SSE-KMS方式加密的对象即使设置了ACL，跨租户也不生效。 OBS用户在上传对象时可以设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改或者获取ACL。 #### 接口约束 - 您必须是桶拥有者或拥有设置对象ACL的权限，才能设置对象ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectAcl权限，如果使用桶策略则需授予PutObjectAcl权限。相关授权方式介绍可参见[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_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 - 一个对象的ACL最多支持配置100条规则。 #### 方法定义 **func** (obsClient ObsClient) SetObjectAcl(input \*[SetObjectAclInput], extensions...extensionOptions) (output \*[BaseModel], err error) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | \*[SetObjectAclInput] | 必选 | **参数解释：** 设置对象ACL请求参数。详情参见[SetObjectAclInput]。 | | extensions | [extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html) | 可选 | **参数解释：** 拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考[extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html)。 | 表2SetObjectAclInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶命名规则如下： - 需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。用户删除桶后，立即创建同名桶或并行文件系统会创建失败，需要等待30分钟才能创建。 - 长度范围为3到63个字符，仅支持小写字母、数字、中划线（-）、英文句号（.）。 - 禁止两个英文句号（.）相邻，禁止英文句号（.）和中划线（-）相邻，禁止以英文句号（.）和中划线（-）开头或结尾。 - 禁止使用IP地址。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | Key | string | 必选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | VersionId | string | 可选 | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | ACL | [AclType] | 可选 | **参数解释：** 预定义ACL。 **取值范围：** AclType取值详见[AclType]。 **默认取值：** 无 | | Owner | [Owner] | 可选 | **参数解释：** 对象的所有者账号户ID，详见[Owner]。 **约束限制：** Owner和Grants必须配套使用，且与ACL互斥。 | | Grants | \[\][Grant] | 可选 | **参数解释：** 被授权用户权限信息，详见[Grant]。 **默认取值：** 无 | 表3AclType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | AclPrivate | private | 私有读写。 桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 | | AclPublicRead | public-read | 公共读私有写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上，所有人可以获取该对象内容和元数据。 | | AclPublicReadWrite | public-read-write | 公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。 设在对象上，所有人可以获取该对象内容和元数据。 | | AclPublicReadDelivered | public-read-delivered | 桶公共读，桶内对象公共读。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadDelivered不能应用于对象。 | | AclPublicReadWriteDelivered | public-read-write-delivered | 桶公共读写，桶内对象公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadWriteDelivered不能应用于对象。 | | AclBucketOwnerFullControl | bucket-owner-full-control | 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。 默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control后，用户B就拥有了对象x的控制权。 | 表4Owner | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 作为请求参数时必选 | **参数解释：** 所有者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？](https://support.huaweicloud.com/sdk-go-devg-obs/obs_23_1712.html) | 表5Grant | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Grantee | [Grantee] | 作为请求参数时必选 | **参数解释：** 被授权用户相关信息，详见[Grantee]。 | | Permission | [PermissionType] | 作为请求参数时必选 | **参数解释：** 被授予的权限。 **取值范围：** 权限取值范围详见[PermissionType]。 **默认取值：** 无 | 表6Grantee | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Type | [GranteeType] | 作为请求参数时必选 | **参数解释：** 被授权用户的类型。 **取值范围：** 被授权用户类型的取值范围详见[GranteeType]。 **默认取值：** 无 | | ID | string | 作为请求参数时，如果Type为用户类型则必选。 | **参数解释：** 被授权用户的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？](https://support.huaweicloud.com/sdk-go-devg-obs/obs_23_1712.html) **默认取值：** 无 | | DisplayName | string | 作为请求参数时可选 | **参数解释：** 被授权用户的账号名。 **约束限制：** - 不支持中文。 - 只能以字母开头。 - 长度为6-32个字符。 - 只能包含英文字母、数字或特殊字符(-_)。 **默认取值：** 无 | | URI | [GroupUriType] | 作为请求参数时，如果Type为用户组类型则必选。 | **参数解释：** 被授权的用户组。 **取值范围：** 授权用户组取值范围详见[GroupUriType]。 **默认取值：** 无 | 表7PermissionType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | PermissionRead | READ | 读权限。 | | PermissionWrite | WRITE | 写权限。 | | PermissionReadAcp | READ_ACP | 读取ACL配置的权限。 | | PermissionWriteAcp | WRITE_ACP | 修改ACL配置的权限。 | | PermissionFullControl | FULL_CONTROL | 完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。 | 表8GranteeType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | GranteeGroup | Group | 用户组。 | | GranteeUser | CanonicalUser | 单个用户。 | 表9GroupUriType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | GroupAllUsers | AllUsers | 所有用户。 | #### 返回结果说明 表10返回结果 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | output | \*[BaseModel] | **参数解释：** 接口返回信息。详情参见[BaseModel]。 | | err | error | **参数解释：** 接口返回错误信息。 | 表11BaseModel | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | StatusCode | int | **参数解释：** HTTP状态码。 **约束限制：** 无 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | ResponseHeaders | map\[string\]\[\]string | **参数解释：** HTTP响应头信息。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 代码示例 本示例用于设置examplebucket桶下example/objectname对象的对象ACL为私有。 ``` package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。 securityToken := os.Getenv("SecurityToken") // endpoint填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken)) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } input := &obs.SetObjectAclInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定对象Acl，此处以私有为例 input.ACL = obs.AclPrivate // 设置对象ACL output, err := obsClient.SetObjectAcl(input) if err == nil { fmt.Printf("Set Object(%s)'s acl successful with Bucket(%s)!\n", input.Key, input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Set Object(%s)'s acl fail with Bucket(%s)!\n", input.Key, input.Bucket) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("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.") fmt.Println(err) } } ``` #### 相关链接 - 关于设置对象ACL的API说明，请参见[设置对象ACL](https://support.huaweicloud.com/api-obs/obs_04_0089.html)。 - 更多关于设置对象ACL的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-go-obs/blob/master/examples/object_operations_sample.go)。 - 设置对象ACL过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。