对象存储服务 OBS-设置对象ACL(Python SDK):请求参数
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketName |
str |
必选 |
参数解释: 桶名。 约束限制:
默认取值: 无 |
objectKey |
str |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
acl |
可选 |
参数解释: 对象的访问权限。 取值范围: acl取值详见ACL。 默认取值: 无 |
|
versionId |
str |
可选 |
参数解释: 对象的版本号。例如:G001117FCE89978B0000401205D5DC9A。 取值范围: 长度为32的字符串。 默认取值: 无 |
aclControl |
可选 |
参数解释: 预定义访问策略。详见HeadPermission 默认取值: 无 |
|
extensionHeaders |
dict |
可选 |
参数解释: 接口的拓展头域。 取值范围: 参考自定义头域。 默认取值: 无 |
acl与aclControl互斥。
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
owner |
作为请求参数时必选 |
参数解释: 所有者信息。详见Owner。 约束限制: Owner和Grants必须配套使用,且与aclControl互斥。 默认取值: 无 |
|
grants |
list of Grant |
作为请求参数时必选 |
参数解释: 被授权用户权限信息列表。详见Grant。 约束限制: Owner和Grants必须配套使用,且与aclControl互斥。 默认取值: 无 |
delivered |
bool |
作为请求参数时可选 |
参数解释: 桶的ACL是否向桶内对象传递,仅在设置对象权限时有效。 取值范围: True:桶内传递对象 False:不向桶内传递对象 默认取值: False |
常量名 |
原始值 |
说明 |
---|---|---|
HeadPermission.PRIVATE |
private |
私有读写。 桶或对象的所有者拥有完全控制的权限,其他任何人都没有访问权限。 |
HeadPermission.PUBLIC_READ |
public-read |
公共读私有写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上,所有人可以获取该对象内容和元数据。 |
HeadPermission.PUBLIC_READ_WRITE |
public-read-write |
公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。 设在对象上,所有人可以获取该对象内容和元数据。 |
HeadPermission.PUBLIC_READ_DELIVERED |
public-read-delivered |
桶公共读,桶内对象公共读。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本,可以获取该桶内对象的内容和元数据。
说明:
PUBLIC_READ_DELIVERED不能应用于对象。 |
HeadPermission.PUBLIC_READ_WRITE_DELIVERED |
public-read-write-delivered |
桶公共读写,桶内对象公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务,可以获取该桶内对象的内容和元数据。
说明:
PUBLIC_READ_WRITE_DELIVERED不能应用于对象。 |
HeadPermission.BUCKET_OWNER_FULL_CONTROL |
public-read-write-delivered |
设在对象上,桶和对象的所有者拥有对象的完全控制权限,其他任何人都没有访问权限。默认情况下,上传对象至其他用户的桶中,桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后,桶所有者可以完全控制对象。例如,用户A上传对象x至用户B的桶中,系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后,用户B就拥有了对象x的控制权。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
owner_id |
str |
作为请求参数时必选 |
参数解释: 所有者的账号ID,即domain_id。 取值范围: 如何获取账号ID请参见如何获取账号ID和用户ID? 默认取值: 无 |
owner_name |
str |
作为请求参数时可选 |
参数解释: 所有者的账号用户名。 取值范围: 如何获取账号用户名请参见如何获取用户名? 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
grantee |
作为请求参数时必选 |
参数解释: 被授权用户。 取值范围: 被授权用户类型的取值范围详见Grantee。 默认取值: 无 |
|
permission |
str |
作为请求参数时必选 |
参数解释: 被授予的权限。 取值范围: 权限取值范围详见权限。 默认取值: 无 |
delivered |
bool |
作为请求参数时可选 |
参数解释: 桶的ACL是否向桶内对象传递。作用于桶内所有对象。 取值范围: True:是,桶ACL向桶内对象传递。 False:否,桶ACL不向桶内对象传递,仅作用于桶。 默认取值: False |
常量值 |
说明 |
---|---|
READ |
读权限。 如果有桶的读权限,则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限,则可以获取该对象内容和元数据。 |
WRITE |
写权限。 如果有桶的写权限,则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 |
READ_ACP |
读取ACL配置的权限。 如果有读ACP的权限,则可以获取对应的桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 |
WRITE_ACP |
修改ACL配置的权限。 如果有写ACP的权限,则可以更新对应桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限,由于可以更改权限控制策略,实际上意味着拥有了完全访问的权限。 |
FULL_CONTROL |
完全控制权限,包括对桶或对象的读写权限,以及对桶或对象ACL配置的读写权限。 如果有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。 如果有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
grantee_id |
str |
作为请求参数时,如果group为空则必选。 |
参数解释: 被授权用户的账号ID,即domain_id。 取值范围: 如何获取账号ID请参见获取账号ID。 默认取值: 无 |
grantee_name |
str |
作为请求参数时可选 |
参数解释: 被授权用户的账号名。 约束限制:
默认取值: 无 |
group |
str |
作为请求参数时,如果grantee_id为空则必选。 |
参数解释: 被授权的用户组。 取值范围: 授权用户组取值范围详见用户组。 默认取值: 无 |