Python管理软链接

更新时间:2025-03-12 10:30:18

本文介绍如何在受版本控制的存储空间(Bucket)中管理软链接。

注意事项

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

  • 要创建软链接,您必须具有oss:PutObject权限;要获取软链接,您必须具有oss:GetObject权限。具体操作,请参见RAM用户授权自定义的权限策略

示例代码

创建软链接

说明
  • 软链接本身也可以有多个版本,每个不同的版本可以指向不同的TargetObject,版本IDOSS自动生成,在响应header中返回x-oss-version-id。

  • 在受版本控制的Bucket中,无法为删除标记(Delete Marker)创建软链接。

您可以使用以下代码创建软链接指向TargetObject的当前版本。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:创建软链接
parser = argparse.ArgumentParser(description="put symlink sample")

# 添加命令行参数 --region,表示存储空间所在的区域,必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket,表示存储空间的名称,必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint,表示其他服务可用来访问OSS的域名,非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# 添加命令行参数 --key,表示对象的名称,必需参数
parser.add_argument('--key', help='The name of the object.', required=True)
# 添加命令行参数 --target,表示软链接指向的目标对象,必需参数
parser.add_argument('--target', help='The destination object to which the symbolic link points.', required=True)

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

    # 从环境变量中加载访问OSS所需的认证信息,用于身份验证
    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_symlink(oss.PutSymlinkRequest(
        bucket=args.bucket,  # 指定目标存储空间名称
        key=args.key,        # 指定软链接对象名称
        target=args.target,  # 指定软链接指向的目标对象
    ))

    # 打印操作结果的状态码、请求ID以及其他相关信息,以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'  # 版本ID(如果有)
          )

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

获取软链接

说明
  • 获取软链接操作需要您对该软链接有读权限。

  • GetSymlink接口默认获取软链接的当前版本。允许通过指定versionId来获取指定版本。如果软链接的当前版本为删除标记,OSS会返回404 Not Found,在响应header中返回x-oss-delete-marker = true以及版本ID:x-oss-version-id。

您可以使用以下代码获取软链接。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:获取软链接信息
parser = argparse.ArgumentParser(description="get symlink sample")

# 添加命令行参数 --region,表示存储空间所在的区域,必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket,表示存储空间的名称,必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint,表示其他服务可用来访问OSS的域名,非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# 添加命令行参数 --key,表示对象的名称,必需参数
parser.add_argument('--key', help='The name of the object.', required=True)
# 添加命令行参数 --version_id,表示对象的版本ID,必需参数
parser.add_argument('--version_id', help='The version id of the object.', required=True)

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

    # 从环境变量中加载访问OSS所需的认证信息,用于身份验证
    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_symlink(oss.GetSymlinkRequest(
        bucket=args.bucket,      # 指定存储空间名称
        key=args.key,            # 指定软链接对象名称
        version_id=args.version_id  # 指定软链接对象的版本ID
    ))

    # 打印操作结果的状态码、请求ID、版本ID、目标对象以及ETag等信息,以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
          f' target: {result.target},'
          f' etag: {result.etag},'
          )

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

相关文档

  • 关于创建软链接的完整示例代码,请参见put_symlink.py

  • 关于获取软链接的完整示例代码,请参见get_symlink.py

  • 本页导读 (1)
  • 注意事项
  • 示例代码
  • 创建软链接
  • 获取软链接
  • 相关文档
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等