Batch Deleting Objects (SDK for Go)

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.

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, OBS may encounter an internal error during cyclic deletion of multiple objects. In that case, the metadata still exists when the object index data is deleted, which means data inconsistency.

Method

func (obsClient ObsClient) DeleteObjects(input *DeleteObjectsInput) (output *DeleteObjectsOutput, err error)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
input	*DeleteObjectsInput	Yes	Explanation: Input parameters for batch deleting objects. For details, see Table 2.

**Table 2** DeleteObjectsInput
Parameter	Type	Mandatory (Yes/No)	Description
Bucket	string	Yes	Explanation: Bucket name Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None
Quiet	bool	No	Explanation: Response to the request for deleting objects in a batch Value range: false: The detailed mode. Results of both successful and failed deletions are returned. true: The quiet mode. Only results of failed deletions are returned. Default value: false
Objects	[]ObjectToDelete	Yes	Explanation: List of objects to be deleted. For details, see Table 3.
EncodingType	string	No	Explanation: Encoding type for Key in the response. If Key in the response contains control characters that are not supported by the XML 1.0 standard, you can specify this parameter to encode Key. Value range: url Default value: None. If you leave this parameter blank, encoding is not applied to Key.

**Table 3** ObjectToDelete
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: ID of the object version to delete, for example, G001117FCE89978B0000401205D5DC9 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

**Table 4** List of returned results
Parameter	Type	Description
output	*DeleteObjectsOutput	Explanation: Returned results. For details, see Table 5.
err	error	Explanation: Error messages returned by the API

**Table 5** DeleteObjectsOutput
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
RequestId	string	Explanation: Request ID returned by the OBS server Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers Default value: None
Deleteds	[]Deleted	Explanation: List of objects that are successfully deleted. For details, see Table 6.
Errors	[]Error	Explanation: List of objects that fail to be deleted. For details, see Table 7.
EncodingType	string	Explanation: Encoding type for Key in the response. If Key in the response contains control characters that are not supported by the XML 1.0 standard, you can specify this parameter to encode Key. Value range: url Default value: None. If you leave this parameter blank, encoding is not applied to Key.

**Table 6** Deleted
Parameter	Type	Description
Key	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
VersionId	string	Explanation: ID of the object version to delete, for example, G001117FCE89978B0000401205D5DC9 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.
DeleteMarker	bool	Explanation: Whether the deleted object is a delete marker Value range: true: The deleted object is a delete marker. false: The deleted object is not a delete marker. Default value: false
DeleteMarkerVersionId	string	Explanation: Version ID of the delete marker to create or delete. If the request either creates or deletes a delete marker, OBS returns this element in response with the version ID of the delete marker. This element will be returned in either of the following cases: You send a delete request with no version ID specified. In this case, OBS creates the delete marker and returns its version ID in the response. You send a delete request with an object name and a version ID specified, but this version ID represents a delete marker. In this case, OBS deletes the delete marker and returns its version ID in the response. Default value: None

**Table 7** Error
Parameter	Type	Description
Key	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
VersionId	string	Explanation: ID of the object version to delete, for example, G001117FCE89978B0000401205D5DC9 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.
Code	string	Explanation: Error code of the deletion failure. For details, see OBS Error Codes.
Message	string	Explanation: Error message of the deletion failure. For details, see OBS Error Codes.

Code Examples

This example deletes objects key1, key2, and key3 from bucket examplebucket in a batch.

    
     
       
       
         package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding to reduce leakage risks. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    // securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.DeleteObjectsInput{}
    // Specify a bucket name.
    input.Bucket = "examplebucket"
    // Specify the list of objects to delete.
    var objects [3]obs.ObjectToDelete
    objects[0] = obs.ObjectToDelete{Key: "key1", VersionId: ""}
    objects[1] = obs.ObjectToDelete{Key: "key2", VersionId: ""}
    objects[2] = obs.ObjectToDelete{Key: "key3", VersionId: ""}
    input.Objects = objects[:]
    // Batch delete the objects.
    output, err := obsClient.DeleteObjects(input)
    if err == nil {
        fmt.Printf("Delete objects under the bucket(%s) successful!\n", input.Bucket)
        for index, deleted := range output.Deleteds {
            fmt.Printf("Deleted[%d]-Key:%s, VersionId:%s\n", index, deleted.Key, deleted.VersionId)
        }
        for index, err := range output.Errors {
            fmt.Printf("Error[%d]-Key:%s, Code:%s\n", index, err.Key, err.Code)
        }
        return
    }
    fmt.Printf("Delete objects under the bucket(%s) fail!\n", 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)
    }
}

        

      

    
   