文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 归档直读(Python SDK)/ 设置桶归档存储冷存储对象直读策略(Python SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置桶归档存储冷存储对象直读策略(Python SDK)

功能介绍

归档存储冷存储对象直读是指用户可以不用恢复归档存储冷存储对象，便能直接对其进行操作。

默认情况下，桶没有开启归档存储冷存储对象直读功能。

本接口主要用来开启或关闭桶的归档存储冷存储对象直读功能。

  • 设置桶的归档存储冷存储对象直读状态为Enabled，开启桶的归档存储冷存储对象直读功能：
    • 桶内存在归档存储冷存储对象时，不管该归档存储冷存储对象是否已经恢复，均可以直接操作该归档存储冷存储对象。
    • 如果归档存储冷存储对象没有恢复，操作该归档存储冷存储对象时会增加单独计费。
  • 设置桶的归档存储冷存储对象直读状态为Disabled，关闭桶的归档存储冷存储对象直读功能：
    • 归档存储冷存储对象无法直接操作，需要先恢复。

对象直读是指用户可以不用恢复归档存储冷存储对象，便能直接对其进行操作。了解更多归档存储冷存储数据直读相关信息，请参见归档数据直读。

接口约束

  • 您必须是桶拥有者或者拥有设置桶归档存储冷存储对象直读策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutDirectColdAccessConfiguration权限，如果使用桶策略则需授予PutDirectColdAccessConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
  • 融合桶不支持归档存储冷存储对象直读。

方法定义

ObsClient.setBucketDirectColdAccess(bucketName, directColdAccessConfiguration, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

directColdAccessConfiguration

表1 DirectColdAccessConfiguration

必选

参数解释：

桶的归档存储冷存储对象直读策略，详见表1 DirectColdAccessConfiguration。

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 DirectColdAccessConfiguration

参数名称

参数类型

是否必选

描述

status

str

必选

参数解释：

标识桶的归档存储冷存储对象直读状态。

取值范围：

  • Enabled：开启归档存储冷存储对象直读策略。
  • Disabled：关闭归档存储冷存储对象直读策略。

默认取值：

无

返回结果说明

类型

说明

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桶的DirectColdAccess策略。

 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
 
from obs import ObsClient, DirectColdAccessConfiguration
import os
import traceback

# 推荐通过环境变量获取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值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    config = DirectColdAccessConfiguration(status='Enabled')
    # 设置桶的DirectColdAccess策略
    resp = obsClient.setBucketDirectColdAccess(bucketName, config)

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

相关文档