Batch Deleting Objects (SDK for Java)

Function

This API deletes objects in batches from a specific bucket. Deleted objects cannot be recovered.

In a batch delete operation, OBS concurrently deletes the specified objects and returns the deletion result of each object.

If you have any questions during development, post them on the Issues page of GitHub.

Restrictions

• To delete objects in a batch, you must be the bucket owner or have the required permission (obs:object:DeleteObject in IAM or DeleteObject in a bucket 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.
• If versioning is not enabled for a bucket, deleted objects cannot be recovered.
• A maximum of 1,000 objects can be deleted at a time. If you send a request for deleting more than 1,000 objects, OBS returns an error message.
• After concurrent tasks are assigned, if an internal error occurs during cyclic deletion of multiple objects, an object may be deleted in the index data but still exist in the metadata.

Method

obsClient.deleteObjects(DeleteObjectsRequest deleteRequest)

Request Parameters

Responses

Code Examples

This example deletes all objects whose names start with exampleObjectPrefix in bucket example-bucket in a batch. Note that if exampleObjectPrefix is left blank, all objects in the bucket will be deleted.

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.DeleteObjectsRequest;
import com.obs.services.model.DeleteObjectsResult;
import com.obs.services.model.ListVersionsRequest;
import com.obs.services.model.ListVersionsResult;
import com.obs.services.model.VersionOrDeleteMarker;
import java.util.Map;

public class DeleteObjects002 {
    public static void main(String[] args) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        // String endPoint = System.getenv("ENDPOINT");

        // Create a single instance of ObsClient.
        // Use a permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use a temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            String exampleBucket = "example-bucket";
            String exampleObjectPrefix = "exampleObjectPrefix";
            // Batch delete the objects.
            ListVersionsRequest request = new ListVersionsRequest(exampleBucket);
            // Delete 100 objects at a time.
            request.setMaxKeys(100);
            request.setPrefix(exampleObjectPrefix);
            ListVersionsResult result;
            do {
                result = obsClient.listVersions(request);
                DeleteObjectsRequest deleteRequest = new DeleteObjectsRequest(exampleBucket);
                // deleteRequest.setQuiet(true); // This demo uses the verbose mode by default. To use the quiet mode, add this line of code.
                for (VersionOrDeleteMarker v : result.getVersions()) {
                    // Obtain object names and version IDs.
                    deleteRequest.addKeyAndVersion(v.getKey(), v.getVersionId());
                }
                if(deleteRequest.getKeyAndVersions().length > 0){
                    DeleteObjectsResult deleteResult = obsClient.deleteObjects(deleteRequest);
                    // Print the deleted objects.
                    System.out.println("DeletedObjectResults:"+ deleteResult.getDeletedObjectResults());
                    // Print the objects that were not deleted.
                    System.out.println("ErrorResults:"+ deleteResult.getErrorResults());
                }else{
                    System.out.println("No object to delete");
                }
                request.setKeyMarker(result.getNextKeyMarker());
                // If versioning is not enabled, do not configure VersionIdMarker.
                request.setVersionIdMarker(result.getNextVersionIdMarker());
            } while (result.isTruncated());
            System.out.println("deleteObjects successfully");
        } catch (ObsException e) {
            System.out.println("deleteObjects failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            Map<String, String> headers = e.getResponseHeaders();// Check Map entries and print all headers associated with the error.
            if(headers != null){
                for (Map.Entry<String, String> header : headers.entrySet()) {
                    if(header.getKey().contains("error")){
                        System.out.println(header.getKey()+":"+header.getValue());
                    }
                }
            }
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("deleteObjects failed");
            // Print other error details.
            e.printStackTrace();
        }
    }
}

This example batch deletes all objects in bucket examplebucket. Exercise caution when performing this operation.

 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.DeleteObjectsRequest;
import com.obs.services.model.DeleteObjectsResult;
import com.obs.services.model.ListVersionsRequest;
import com.obs.services.model.ListVersionsResult;
import com.obs.services.model.VersionOrDeleteMarker;
public class DeleteObjects001 {
    public static void main(String[] args) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in your actual situation.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        //String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use the permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use the temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // Batch delete the objects.
            ListVersionsRequest request = new ListVersionsRequest("examplebucket");
            // Delete 100 objects at a time.
            request.setMaxKeys(100);
            ListVersionsResult result;
            do {
                result = obsClient.listVersions(request);
                DeleteObjectsRequest deleteRequest = new DeleteObjectsRequest("examplebucket");
                //deleteRequest.setQuiet(true); // This demo uses the verbose mode by default. To use the quiet mode, add this line of code.
                for (VersionOrDeleteMarker v : result.getVersions()) {
                    // Obtain objects' names and version IDs.
                    deleteRequest.addKeyAndVersion(v.getKey(), v.getVersionId());
                }
                if(deleteRequest.getKeyAndVersions().length > 0){
                    DeleteObjectsResult deleteResult = obsClient.deleteObjects(deleteRequest);
                    // Obtain successfully deleted objects.
                    System.out.println("DeletedObjectResults:"+ deleteResult.getDeletedObjectResults());
                    // Obtain objects failed to be deleted.
                    System.out.println("ErrorResults:"+ deleteResult.getErrorResults());
                }else{
                    System.out.println("No object to delete");
                }
                request.setKeyMarker(result.getNextKeyMarker());
                // If versioning is not enabled, do not configure VersionIdMarker.
                request.setVersionIdMarker(result.getNextVersionIdMarker());
            } while (result.isTruncated());
            System.out.println("deleteObjects successfully");
        } catch (ObsException e) {
            System.out.println("deleteObjects failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("deleteObjects failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}

Helpful Links

• Deleting Objects
• (GitHub) Sample Code for Object Deletion
• OBS Error Codes