文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 对象相关接口(Python SDK)/ 获取对象ACL(Python SDK)
更新时间：2024-11-26 GMT+08:00
查看PDF
分享

获取对象ACL(Python SDK)

功能说明

用户执行获取对象ACL的操作，返回信息包含指定对象的权限控制列表信息。可以通过本接口获取指定桶中对象的访问权限。

接口约束

  • 您必须是桶拥有者或拥有获取对象ACL的权限，才能获取对象ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObjectAcl权限，如果使用桶策略则需授予GetObjectAcl权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 用户必须拥有对指定对象读ACP(access control policy)的权限，才能执行获取对象ACL的操作。

方法定义

ObsClient.getObjectAcl(bucketName, objectKey, versionId, extensionHeaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

str

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

versionId

str

可选

参数解释：

对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。

取值范围：

长度为32的字符串。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

返回结果

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无
表4 GetResult.body

GetResult.body类型

说明

ACL

参数解释：

对象的访问权限。详见ACL。

默认取值：

无
表5 ACL

参数名称

参数类型

是否必选

描述

owner

Owner

作为请求参数时必选

参数解释：

所有者信息。详见Owner。

约束限制：

owner和grants必须配套使用，且与ACL互斥。

默认取值：

无

grants

list of Grant

作为请求参数时必选

参数解释：

被授权用户权限信息列表。详见Grant。

默认取值：

无

delivered

bool

作为请求参数时可选

参数解释：

桶的ACL是否向桶内对象传递。作用于桶内所有对象。

取值范围：

True：是，桶ACL向桶内对象传递。

False：否，桶ACL不向桶内对象传递，仅作用于桶。

默认取值：

False
表6 Owner

参数名称

参数类型

是否必选

描述

owner_id

str

作为请求参数时必选

参数解释：

所有者的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID?

默认取值：

无

owner_name

str

作为请求参数时可选

参数解释：

所有者的账号用户名。

取值范围：

如何获取账号用户名请参见如何获取用户名?

默认取值：

无
表7 Grant

参数名称

参数类型

是否必选

描述

grantee

Grantee

作为请求参数时必选

参数解释：

被授权用户相关信息，详见Grantee。

默认取值：

无

permission

str

作为请求参数时必选

参数解释：

被授予的权限。

取值范围：

权限取值范围详见权限。

默认取值：

无

delivered

bool

作为请求参数时可选

参数解释：

桶的ACL是否向桶内对象传递。作用于桶内所有对象。

取值范围：

True：是，桶ACL向桶内对象传递。

False：否，桶ACL不向桶内对象传递，仅作用于桶。

默认取值：

False
表8 Permission

常量值

说明

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的权限。
表9 Grantee

参数名称

参数类型

是否必选

描述

grantee_id

str

作为请求参数时，如果group为空则必选。

参数解释：

被授权用户的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见获取账号ID。

默认取值：

无

grantee_name

str

作为请求参数时可选

参数解释：

被授权用户的账号名。

约束限制：

  • 不支持中文。
  • 只能以字母开头。
  • 长度为6-32个字符。
  • 只能包含英文字母、数字或特殊字符(-_)。

默认取值：

无

group

str

作为请求参数时，如果grantee_id为空则必选。

参数解释：

被授权的用户组。

取值范围：

授权用户组取值范围详见用户组。

默认取值：

无
表10 Group

常量值

说明

ALL_USERS

所有用户。

AUTHENTICATED_USERS

授权用户，已废弃。

LOG_DELIVERY

日志投递组，已废弃。

代码样例

本示例用于获取examplebucket桶里objectname的访问权限。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写
server = "https://obs.ap-southeast-1.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    objectKey = "objectname"
    # 获取指定桶中对象的访问权限
    resp = obsClient.getObjectAcl(bucketName, objectKey)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Get Object Acl Succeeded')
        print('requestId:', resp.requestId)
        print('owner_id:', resp.body.owner.owner_id)
        print('owner_name:', resp.body.owner.owner_name)

        index = 1
        for grant in resp.body.grants:
            print('grant [' + str(index) + ']')
            print('grantee_id:', grant.grantee.grantee_id)
            print('grantee_name:', grant.grantee.grantee_name)
            print('group:', grant.grantee.group)
            print('permission:', grant.permission)
            index += 1
    else:
        print('Get Object Acl Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Get Object Acl Failed')
    print(traceback.format_exc())

相关链接

  • 关于获取对象ACL的API说明，请参见获取对象ACL。
  • 更多关于获取对象ACL的示例代码，请参见Github示例。
  • 获取对象ACL过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。