对象存储BOS-BOS Python SDK文档-百度开放云

BOS Python SDK文档简介本文档主要介绍BOS Python SDK的安装和使用。

在使用本文档前，您需要先了解BOS的一些基本知识，并已开通了BOS 服务。

若您还不了解BOS，可以参考产品描述和入门指南。

安装SDK工具包运行环境Python SDK工具包支持在Python 2.7环境下运行。

安装步骤1.在官方网站下载BOS Python SDK。

2.进入下载目录。

3.在脚本文件中添加以下代码，即可以使用SDK包：python setup.py installSDK目录结构baidubce├──auth//公共权限目录├──services//服务公共目录│└──bos//BOS目录└──http//Http请求模块快速入门1.初始化一个BOSClient。

bos_client是与BOS服务交互的客户端，BOS Python SDK的BOS操作都是通过bos_client完成的。

用户可以参考BOSClient。

完成初始化客户端的操作。

2.新建一个Bucket。

Bucket是BOS上的命名空间，相当于数据的容器，可以存储若干数据实体（Object）。

用户可以参考新建Bucket来完成新建一个Bucket的操作。

针对Bucket的命名规范，可以参考Bucket命名规范。

3.上传Object。

Object是BOS中最基本的数据单元，用户可以把Object简单的理解为文件。

用户可以参考上传Object完成对Object的上传。

4.列出指定Bucket中的全部Object。

当用户完成一系列上传后，可以参考查看Bucket中Object列表来查看指定Bucket下的全部Object。

5.获取指定Object用户可以参考获取Object来实现对一个或者多个Object的获取。

BOSClient配置BOSClientBOSClient是BOS服务的Python客户端，为调用者与BOS服务进行交互提供了一系列的方法。

在新建BOSClient之前，需要先创建配置文件对BOSClient进行配置，以下将此配置文件命名为bos_sample_conf.py，具体配置信息如下所示：#!/usr/bin/env python#coding=utf-8#导入Python标准日志模块import logging#从Python SDK导入BOS配置管理模块以及安全认证模块from baidubce.bce_client_configuration import BceClientConfigurationfrom baidubce.auth.bce_credentials import BceCredentials#设置访问BOS服务的代理PROXY_HOST='localhost:8080'#设置BosClient的Host，Access Key ID和Secret Access Keybos_host="BOS_HOST"access_key_id="AK"secret_access_key="SK"#设置日志文件的句柄和日志级别logger=logging.getLogger('baidubce.services.bos.bosclient')fh=logging.FileHandler("sample.log")fh.setLevel(logging.DEBUG)#设置日志文件输出的顺序、结构和内容formatter=logging.Formatter('%(asctime)s-%(name)s-%(levelname)s-%(message)s')fh.setFormatter(formatter)logger.setLevel(logging.DEBUG)logger.addHandler(fh)#创建BceClientConfigurationconfig=BceClientConfiguration(credentials=BceCredentials(access_key_id,secret_access_key),endpoint= bos_host)注意：1.访问BOS服务的代理参数PROXY_HOST可缺省。

2.针对日志文件，Logging有如下级别：DEBUG，INFO，WARNING，ERROR，CRITICAL。

新建BOSClient在完成上述配置之后，参考如下代码新建一个BosClient。

#导入BOSClient配置文件import bos_sample_conf#导入BOS相关模块from baidubce import exceptionfrom baidubce.services import bosfrom baidubce.services.bos import canned_aclfrom baidubce.services.bos.bos_client import BosClient#新建BOSClientbos_client=BosClient(bos_sample_conf.config)设置网络参数用户可以设置一些网络参数：#设置请求超时时间bos_sample_conf.config.connection_timeout_in_mills(TIMEOUT)#设置接收缓冲区大小bos_sample_conf.config.recv_buf_size(BUF_SIZE)#设置发送缓冲区大小bos_sample_conf.config.send_buf_size(BUF_SIZE)#设置连接重试策略#三次指数退避重试bos_sample_conf.config.retry_policy=BackOffRetryPolicy()#不重试bos_sample_conf.config.retry_policy=NoRetryPolicy()参数说明通过bos_client_configuration能指定的所有参数如下表所示：参数说明port BOS端口号send_buf_size发送缓冲区大小recv_buf_size接收缓冲区大小connection_timeout_in_mills请求超时时间（单位：毫秒）retry_policy连接重试策略，初始化Client时默认为三次指数退避BucketBucket命名规范Bucket既是BOS上的命名空间，也是计费、权限控制、日志记录等高级功能的管理实体。

•Bucket名称在一个Region中具有全局唯一性，且不能修改。

•存储在BOS上的每个Object都必须包含在一个Bucket中。

•一个用户最多可创建100个Bucket，但每个Bucket中存放的Object的数量和大小总和没有限制，用户不需要考虑数据的可扩展性。

Bucket的命名有以下规范：•只能包括小写字母，数字，短横线（-）。

•必须以小写字母或者数字开头。

•长度必须在3-63字节之间。

新建Bucket如下代码可以新建一个Bucket：if not bos_client.does_bucket_exist(bucket_name):bos_client.create_bucket(bucket_name)注意：注意：由于Bucket的名称在一个Region中是唯一的，所以需要保证bucket_name不与其他所有存在于此Region上的Bucket 名称相同。

查看Bucket列表用如下方式可以列出用户所有的Bucket：response=bos_client.list_buckets()for bucket in response.buckets:print list_bucket方法返回的解析类中可供调用的参数如下：参数说明owner Bucket Owner信息--id Bucket Owner的用户ID--display_name Bucket Owner的名称buckets存放多个Bucket信息的容器--bucket存放一个Bucket信息的容器----name Bucket名称----creation_date Bucket创建时间删除Bucket如下代码可以删除一个Bucket：bos_client.delete_bucket(bucket_name)注意：如果Bucket不为空（即Bucket中有Object存在），则Bucket无法被删除，必须清空Bucket后才能成功删除。

注意：Bucket权限控制设置Bucket的访问权限如下代码将Bucket的权限设置为了private：bos_client.set_bucket_canned_acl(bucket_name,canned_acl.PRIVATE)其中canned_acl中包含三个参数：PRIVATE、PUBLIC_READ、PUBLIC_READ_WRITE，它们分别对应的相关权限为：private、public-read、public-read-write。

关于权限的具体内容可以参考《BOS API文档使用CannedAcl方式的权限控制》。

设置指定用户对Bucket的访问权限BOS提供set_bucket_acl方法来实现指定用户对Bucket的访问权限设置，可以参考如下代码实现：bos_client.set_bucket_acl(bucket_name,[{'grantee':[{'id':'b124deeaf6f641c9ac27700b41a350a8'},{'id':'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}],'permission':['FULL_CONTROL']}])注意：1.id为用户ID，您可在用户信息中查看。

2.permission中的权限设置包含三个值：READ、WRITE、FULL_CONTROL，它们分别对应相关权限。

具体内容可以参考《BOS API文档上传ACL文件方式的权限控制》。

查看Bucket的权限如下代码可以查看Bucket的权限：response=bos_client.get_bucket_acl(bucket_name)bos_client.set_bucket_acl(bucket_name,response.access_control_list)get_bucket_acl方法返回的解析类中可供调用的参数有：参数说明owner Bucket owner信息--id Bucket owner的用户IDaccess_control_list标识Bucket的权限列表--grantee标识被授权人----id被授权人ID--permission标识被授权人的权限检查Bucket是否存在请参考如下代码：bos_client.does_bucket_exist(bucket_name)ObjectObject命名规范在BOS中，用户操作的基本数据单元是Object。