重命名对象
功能介绍
重命名对象操作是指将指定并行文件系统内的一个对象重命名为其他对象名。
接口约束
- 您必须是并行文件系统拥有者或拥有重命名文件的权限,才能重命名文件。建议使用IAM或策略进行授权,如果使用IAM则需授予obs:bucket:PutObject权限,如果使用策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 目前接口仅在并行文件系统支持,普通对象并行文件系统不支持,如何创建并行文件系统请参考创建并行文件系统。
方法定义
obsClient.renameObject(RenameObjectRequest request)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| request | 必选 | 参数解释: 重命名对象请求参数,详见RenameObjectRequest。 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| bucketName | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| objectKey | 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的字符串。 默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| statusCode | int | 参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。 完整的状态码列表请参见状态码。 默认取值: 无 |
| responseHeaders | Map<String, Object> | 参数解释: 响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。 默认取值: 无 |
代码示例
本示例用于将examplebucket并行文件系统中的folderName/originalObjectName对象重命名为newFolderName/newObjectName。
import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.RenameObjectRequest;
import com.obs.services.model.RenameObjectResult;
public class RenameObjectDemo {
private static final String TAG = "RenameObjectDemo";
public void renameObject() {
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
// 您可以登录访问管理控制台获取访问密钥AK/SK
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");
// endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
String endPoint = "https://your-endpoint";
// 创建ObsClient实例
ObsClient obsClient = new ObsClient(ak, sk, endPoint);
try {
// 重命名对象
RenameObjectRequest request = new RenameObjectRequest();
request.setBucketName("examplebucket");
// objectKey 为原对象的完整对象名
request.setObjectKey("folderName/originalObjectName");
// newObjectKey 为目标对象的完整对象名
request.setNewObjectKey("newFolderName/newObjectName");
RenameObjectResult result = obsClient.renameObject(request);
Log.i(TAG, "renameObject successfully");
Log.i(TAG, "HTTP Code:" + result.getStatusCode());
} catch (ObsException e) {
Log.e(TAG, "renameObject failed");
// 请求失败,打印http状态码
Log.e(TAG, "HTTP Code:" + e.getResponseCode());
// 请求失败,打印服务端错误码
Log.e(TAG, "Error Code:" + e.getErrorCode());
// 请求失败,打印详细错误信息
Log.e(TAG, "Error Message:" + e.getErrorMessage());
// 请求失败,打印请求id
Log.e(TAG, "Request ID:" + e.getErrorRequestId());
Log.e(TAG, "Host ID:" + e.getErrorHostId());
} catch (Exception e) {
Log.e(TAG, "renameObject failed");
// 其他异常信息打印
Log.e(TAG, e.getMessage());
}
}
}