Python传输加速

传输加速可提升全球各地用户对OSS的访问速度,适用于远距离数据传输、GBTB级大文件上传和下载的场景。

注意事项

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

方法定义

开启传输加速

put_bucket_transfer_acceleration(request: PutBucketTransferAccelerationRequest, **kwargs) → PutBucketTransferAccelerationResult

查询传输加速状态

get_bucket_transfer_acceleration(request: GetBucketTransferAccelerationRequest, **kwargs) → GetBucketTransferAccelerationResult

请求参数列表

参数名

类型

说明

request

PutBucketTransferAccelerationRequest

设置请求参数,具体请参见PutBucketTransferAccelerationRequest

GetBucketTransferAccelerationRequest

设置请求参数,具体请参见GetBucketTransferAccelerationRequest

返回值列表

类型

说明

PutBucketTransferAccelerationResult

返回值,具体请参见PutBucketTransferAccelerationResult

GetBucketTransferAccelerationResult

返回值,具体请参见GetBucketTransferAccelerationResult

关于开启传输加速方法的完整定义,请参见put_bucket_transfer_acceleration

关于查询传输加速状态方法的完整定义,请参见get_bucket_transfer_acceleration

示例代码

开启传输加速

以下代码用于开启Bucket的传输加速功能:

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:设置存储空间传输加速配置(Transfer Acceleration)
parser = argparse.ArgumentParser(description="put bucket transfer acceleration 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='Whether the transfer acceleration is enabled for this bucket. Default is False.', default=False, type=bool)

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_transfer_acceleration(oss.PutBucketTransferAccelerationRequest(
            bucket=args.bucket,  # 存储空间名
            transfer_acceleration_configuration=oss.TransferAccelerationConfiguration(
                enabled=args.enabled,  # 是否启用传输加速
            ),
    ))

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

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

查询传输加速状态

以下代码用于查询Bucket的传输加速状态:

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:获取存储空间传输加速配置(Transfer Acceleration)
parser = argparse.ArgumentParser(description="get bucket transfer acceleration 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_transfer_acceleration(oss.GetBucketTransferAccelerationRequest(
            bucket=args.bucket,  # 存储空间名
    ))

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

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

相关文档