文档首页/ 对象存储服务 OBS/ Pythoh SDK开发指南（联盟区域）/ 对象相关接口(Python SDK)/ 对象基础操作(Python SDK)/ 文件重命名(Python SDK)
更新时间：2026-07-01 GMT+08:00
查看PDF
分享

文件重命名(Python SDK)

功能说明

对于并行文件系统内的文件支持对文件的重命名操作。

接口约束

  • 您必须是并行文件系统拥有者或拥有重命名文件的权限，才能重命名文件。建议使用IAM或策略进行授权，如果使用IAM则需授予obs:bucket:PutObject权限，如果使用策略则需授予PutObject权限。相关授权方式介绍可参见，配置方式详见、。

方法定义

ObsClient.renameFile(bucketName, objectKey, newObjectKey, extensionHeaders)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

并行文件系统名。

约束限制：

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

默认取值：

无

objectKey

str

必选

参数解释：

对象名。对象名是对象在存储并行文件系统中的唯一标识。对象名是对象在并行文件系统中的完整路径，路径中不包含并行文件系统名。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

newObjectKey

str

必选

参数解释：

新的对象名。对象名是对象在存储并行文件系统中的唯一标识。对象名是对象在并行文件系统中的完整路径，路径中不包含并行文件系统名。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无

返回结果

表2 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表3 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重命名old_name文件为new_name。

 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
34
35
36
37
38
39
 
import os
import traceback

from obs import ObsClient

# 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写桶所在区域的endpoint
server = "https://your-endpoint"

# 创建obsClient实例
# 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) 
try: 
    # 并行文件系统桶名 
    bucket_name = "examplebucket" 
    # 重命名前文件名 
    object_key = 'old_name' 
    # 重命名后文件名 
    new_object_key = 'new_name' 
    # 重命名文件 
    resp = obs_client.renameFile(bucket_name, object_key, new_object_key) 

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

如果返回的HTTP状态码为404，可以进一步通过响应头来判断是指定的并行文件系统不存在或是对象不存在。