Renaming an Object

Function

This API renames an object in the PFS.

Restrictions

• To rename a file, you must be the PFS owner or have the required permission (obs:bucket:PutObject granted using IAM or PutObject granted using a policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
• This API is currently available only for PFSs. For details about how to create a PFS, see Creating a Parallel File System.

Method

obsClient.renameObject(RenameObjectRequest request)

Request Parameters

Responses

Sample Code

This example renames object folderName/originalObjectName in the PFS examplebucket to 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() {
       // Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK and store them in the configuration file or environment variables. In this example, the AK and SK are stored in environment variables for identity authentication. Before running the code in this example, configure environment variables ACCESS_KEY_ID and SECRET_ACCESS_KEY_ID.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://your-endpoint";

        // Create an ObsClient instance.
        ObsClient obsClient = new ObsClient(ak, sk, endPoint);

        try {
            // Rename an object.
            RenameObjectRequest request = new RenameObjectRequest();
            request.setBucketName("examplebucket");
            // objectKey indicates the original object name.
            request.setObjectKey("folderName/originalObjectName");
            // newObjectKey indicates the new object name.
            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");
            // Request failed. Print the HTTP status code.
            Log.e(TAG, "HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            Log.e(TAG, "Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            Log.e(TAG, "Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            Log.e(TAG, "Request ID:" + e.getErrorRequestId());
            Log.e(TAG, "Host ID:" + e.getErrorHostId());
        } catch (Exception e) {
            Log.e(TAG, "renameObject failed");
            // Print other error information.
            Log.e(TAG, e.getMessage());
        }
    }
}