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
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
deleteRequest |
Yes |
Explanation: Request parameters for deleting objects in batches. For details, see Table 2. |
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
bucketName |
String |
Yes |
Explanation: Bucket name. Restrictions:
Default value: None |
keyAndVersions |
List<KeyAndVersion> |
Yes |
Explanation: List of objects to be deleted. For details, see Table 3. |
quiet |
boolean |
No |
Explanation: Response mode to the request for deleting objects in a batch. Value range:
Default value: false |
encodingType |
String |
No |
Explanation: Encoding type for objectKey in the response. If objectKey in the response contains control characters that are not supported by the XML 1.0 standard, you can specify this parameter to encode objectKey. Value range: url Default value: None. If you leave this parameter blank, encoding is not applied. |
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
key |
String |
Yes |
Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
versionId |
String |
No |
Explanation: Object version ID. Value range: The value must contain 32 characters. Default value: None. If this parameter is left blank, the latest version of the object is deleted. |
Responses
Parameter |
Type |
Description |
---|---|---|
statusCode |
int |
Explanation: HTTP status code. Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None |
responseHeaders |
Map<String, Object> |
Explanation: Response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
deletedObjectResults |
List<DeleteObjectResult> |
Explanation: Response results of the request for deleting objects in a batch. For details, see Table 5. |
errorResults |
List<ErrorResult> |
Explanation: List of objects that fail to be deleted. For details, see Table 6. |
Parameter |
Type |
Description |
---|---|---|
statusCode |
int |
Explanation: HTTP status code. Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None |
responseHeaders |
Map<String, Object> |
Explanation: Response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
versionId |
String |
Explanation: Object version ID. Value range: The value must contain 32 characters. Default value: None |
deleteMarker |
boolean |
Explanation: Whether the deleted object is a delete marker. Value range:
Default value: false |
objectKey |
String |
Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
Parameter |
Type |
Description |
---|---|---|
versionId |
String |
Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
errorCode |
String |
Explanation: Error code for the failed deletion. For details, see OBS Error Codes. |
objectKey |
String |
Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
message |
String |
Explanation: Error message for the failed deletion. For details, see OBS Error Codes. |
Code Examples
This example batch deletes all objects in bucket examplebucket.
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 75 |
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.awt.*; 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(); } } } |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot