# 获取桶列表(Python SDK) #### 功能介绍 OBS桶是对象的容器，您上传的文件都存放在桶中。调用获取桶列表接口，可列举当前账号所有地域下符合指定条件的桶。返回结果以桶名的字典序排序。 #### 接口约束 - 您必须拥有obs:bucket:ListAllMyBuckets权限，才能获取桶列表。建议使用IAM进行授权，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ObsClient.listBuckets(isQueryLocation, extensionHeaders) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | isQueryLocation | bool | 可选 | **参数解释：** 是否同时查询桶的区域位置。 **取值范围：** - True：同时查询桶的区域位置 - False：不查询桶的区域位置 **默认取值：** False | | bucketType | string | 可选 | **参数解释** **：** 列举指定类型的桶。 **取值范围：** - OBJECT：获取所有对象桶列表。 - POSIX：获取所有并行文件系统列表。 **默认取值：** 无 | | extensionHeaders | dict | 可选 | **参数解释：** 接口的拓展头域。 **取值范围：** 参考[自定义头域](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1305.html)。 **默认取值：** 无 | #### 返回结果说明 表2返回结果 | **类型** | **说明** | |:---|:---| | [GetResult] | **参数解释：** SDK公共结果对象。 | 表3GetResult | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | status | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | 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时为空。该值根据调用接口的不同而不同，参见"桶相关接口"章节和"对象相关接口"章节的详细描述。 **默认取值：** 无 | 表4GetResult.body | **GetResult.body类型** | **说明** | |:---|:---| | [ListBucketsResponse] | **参数解释：** 获取桶列表响应结果，参考[ListBucketsResponse]。 | 表5ListBucketsResponse | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | buckets | list of [Bucket] | **参数解释：** 桶列表。 **取值范围：** 参考[Bucket]。 | | owner | [Owner] | **参数解释：** 桶的所有者。 **取值范围：** 参考[Owner]。 | 表6Bucket | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | name | str | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用类IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 **默认取值：** 无 | | create_date | str | **参数解释** **：** 桶的创建时间。 **默认取值：** 无 | | location | str | **参数解释** **：** 桶所在的区域。 **约束限制：** 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 **取值范围：** 当前有效的OBS区域和终端节点的更多信息，请参考[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 **默认取值：** 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。 | | bucket_type | str | **参数解释** **：** 桶类型。 **取值范围：** - 对象桶：OBJECT - 文件桶：POSIX。 **默认取值：** 无 | 表7Owner | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | owner_id | str | 作为请求参数时必选 | **参数解释：** 所有者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID?](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1703.html) **默认取值：** 无 | | owner_name | str | 作为请求参数时可选 | **参数解释：** 所有者的账号用户名。 **取值范围：** 如何获取账号用户名请参见[如何获取用户名?](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_1703.html) **默认取值：** 无 | #### 代码样例 本示例用于列举所有桶列表，并查询桶的区域。 ``` import os import traceback from obs import ObsClient # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: # 列举桶，并设置isQueryLocation参数为True，同时查询桶区域 resp = obs_client.listBuckets(True) # 返回码为2xx时，接口调用成功，否则接口调用失败 if resp.status < 300: print('List Buckets Succeeded') print('requestId:', resp.requestId) print('owner_id:', resp.body.owner.owner_id) print('owner_name:', resp.body.owner.owner_name) index = 1 for bucket in resp.body.buckets: print(f'bucket [{index}]') print('name:', bucket.name) print('create_date:', bucket.create_date) print('location:', bucket.location) index += 1 else: print('List Buckets Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: print('List Buckets Failed') print(traceback.format_exc()) ``` #### 相关链接 - 关于获取桶列表的API说明，请参见[获取桶列表](https://support.huaweicloud.com/api-obs/obs_04_0021.html)。 - 获取桶列表过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。