华为云对象存储OBS设置桶存储类型(Python SDK)_云淘科技

华为云云存储

11 月 24, 2023

143 0

功能说明

OBS提供了三种四种存储类型：标准存储、低频访问存储、归档存储、深度归档存储（受限公测中），从而满足客户业务对存储性能、成本的不同诉求，详情可参见OBS存储类型。

调用设置桶存储类型接口，可设置指定桶的存储类型。设置了桶的默认存储类型之后，若上传对象、复制对象和初始化多段上传任务时未指定对象的存储类型，则该对象的存储类型默认与桶的存储类型保持一致。

接口约束

您必须是桶拥有者或拥有设置桶存储类型的权限，才能设置桶存储类型。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:PutBucketStoragePolicy权限，如果使用桶策略则需授予PutBucketStoragePolicy权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketStoragePolicy(bucketName, storageClass)

请求参数说明

参数名称	参数类型	是否必选	描述
bucketName	str	必选	参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
storageClass	str	必选	参数解释：桶的存储类型。取值范围：存储类型取值详见桶的存储类型。默认取值：无

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
桶命名规则如下：

3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
禁止使用IP地址。
禁止以“-”或“.”开头及结尾。
禁止两个“.”相邻（如：“my..bucket”）。
禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

storageClass

str

必选

参数解释：

桶的存储类型。

取值范围：

存储类型取值详见桶的存储类型。

默认取值：

无

表1 StorageClass
参数名称	参数类型	描述
STANDARD	标准存储	参数解释：标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。
WARM	低频访问存储	参数解释：低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。
COLD	归档存储	参数解释：归档存储适用于很少访问（平均一年访问一次）数据的业务场景。

返回结果说明

类型	说明
GetResult	参数解释： SDK公共结果对象。

类型

说明

GetResult

参数解释：

SDK公共结果对象。

表2 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。默认取值：无

代码样例

本示例用于设置名为examplebucket的桶存储类型为标准存储。

from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/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.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    # 设置桶存储类型为标准存储
    storageClass = 'STANDARD'
    # 设置桶存储类型
    resp = obsClient.setBucketStoragePolicy(bucketName, storageClass)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Bucket StoragePolicy Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket StoragePolicy Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Set Bucket StoragePolicy Failed')
    print(traceback.format_exc())