文档首页/ 对象存储服务 OBS/ SDK参考/ Go/ 并行文件系统相关接口(Go SDK)/ 重命名对象(Go SDK)
更新时间：2024-06-21 GMT+08:00
查看PDF
分享

重命名对象(Go SDK)

功能说明

重命名对象操作是指将指定并行文件系统内的一个对象重命名为其他对象名。

接口约束

  • 您必须是并行文件系统拥有者或拥有重命名文件的权限，才能重命名文件。建议使用IAM或策略进行授权，如果使用IAM则需授予obs:bucket:PutObject权限，如果使用策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
  • OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。
  • 目前接口仅在并行文件系统支持，普通对象桶不支持，如何创建并行文件系统请参考创建并行文件系统(Go SDK)。

方法定义

func (obsClient ObsClient) RenameFile(input *RenameFileInput) (output *RenameFileOutput, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*RenameFileInput

必选

参数解释：

重命名对象参数，详见RenameFileInput。
表2 RenameFileInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

并行文件系统名。

约束限制：

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

默认取值：

无

Key

string

必选

参数解释：

目录名。目录名是并行文件系统中目录的路径，路径中不包含并行文件系统名。

例如，您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

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

默认取值：

无

NewObjectKey

string

必选

参数解释：

参数解释：

修改后的目标对象名称。对象名是对象在并行文件系统中的唯一标识。对象名不包含并行文件系统名称。

例如，您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

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

默认取值：

无

返回结果说明

表3 返回结果列表

参数名称

参数类型

描述

output

*RenameFileOutput

参数解释：

接口返回信息，详见RenameFileOutput。

err

error

参数解释：

接口返回错误信息。
表4 RenameFileOutput

参数名称

参数类型

描述

StatusCode

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

RequestId

string

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

ResponseHeaders

map[string][]string

参数解释：

HTTP响应头信息。

默认取值：

无

代码示例

本示例用于将examplebucket并行文件系统中的folderName/originalObjectName对象重命名为newFolderName/newObjectName。 
 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
40
41
42
43
44
 
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写。
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.RenameFileInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定原对象名，此处以 folderName/originalObjectName 为例。
    input.Key = "folderName/originalObjectName"
    // 指定目标对象名，此处以 newFolderName/newObjectName 为例。
    input.NewObjectKey = "newFolderName/newObjectName"
    // 重命名对象
    output, err := obsClient.RenameFile(input)
    if err == nil {
        fmt.Printf("Rename File(%s) successful with bucket(%s)!\n", input.Key, input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Rename File(%s) fail with bucket(%s)!\n", input.Key, input.Bucket)
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}