如何使用Python SDK V2进行归档直读_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用Python SDK V2管理Bucket的归档直读功能。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。

方法定义

开启Bucket归档直读

put_bucket_archive_direct_read(request: PutBucketArchiveDirectReadRequest, **kwargs) → PutBucketArchiveDirectReadResult

查看Bucket是否开启归档直读

get_bucket_archive_direct_read(request: GetBucketArchiveDirectReadRequest, **kwargs) → GetBucketArchiveDirectReadResult

请求参数列表

参数名	类型	说明

参数名	类型	说明
request	PutBucketArchiveDirectReadRequest	设置请求参数，具体请参见PutBucketArchiveDirectReadRequest
request	GetBucketArchiveDirectReadRequest	设置请求参数，具体请参见GetBucketArchiveDirectReadRequest

返回值列表

类型	说明

类型	说明
PutBucketArchiveDirectReadResult	返回值，具体请参见PutBucketArchiveDirectReadResult
GetBucketArchiveDirectReadResult	返回值，具体请参见GetBucketArchiveDirectReadResult

关于开启Bucket归档直读方法的完整定义，请参见put_bucket_archive_direct_read。

关于查看Bucket是否开启归档直读方法的完整定义，请参见get_bucket_archive_direct_read。

示例代码

开启Bucket归档直读

您可以使用以下代码开启Bucket归档直读。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：设置存储空间归档直读配置（Archive Direct Read）
parser = argparse.ArgumentParser(description="put bucket archive direct read sample")

# 定义命令行参数，包括必需的区域、存储空间名称、endpoint以及是否启用归档直读
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--enabled', help='Specifies whether to enable real-time access of Archive objects for a bucket. Valid values: "true" or "false".', required=True)

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 执行请求以设置指定存储空间的归档直读配置
    result = client.put_bucket_archive_direct_read(oss.PutBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # 存储空间名
            archive_direct_read_configuration=oss.ArchiveDirectReadConfiguration(
                enabled=args.enabled.lower() == 'true',  # 将字符串形式的布尔值转换为Python布尔类型
            ),
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

查看Bucket是否开启归档直读

您可以使用以下代码查看Bucket是否开启归档直读。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：获取存储空间归档直读配置（Archive Direct Read）
parser = argparse.ArgumentParser(description="get bucket archive direct read sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 执行请求以获取指定存储空间的归档直读配置详情
    result = client.get_bucket_archive_direct_read(oss.GetBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' enabled: {result.archive_direct_read_configuration.enabled if hasattr(result.archive_direct_read_configuration, "enabled") else "Not set"},'  # 归档直读是否启用，如果没有设置则显示"Not set"
    )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始