DELETE Object

Updated on 2022-02-10 GMT+08:00

View PDF

API Description

You can use this API to delete an object from a specified bucket.

Method Definition

ObsClient.deleteObject

Request Parameter

Field	Type	Optional or Mandatory	Description
Bucket	String	Mandatory	Bucket name
Key	String	Mandatory	Object name
RequestDate	String or Date	Optional	Request time NOTE: When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.
VersionId	String	Optional	Version ID of the object to be deleted

Returned Result (InterfaceResult)

Field	Type	Description
RequestId	String	Request ID returned by the OBS server
DeleteMarker	String	Whether the deleted object is a delete marker
VersionId	String	Version ID of the object to be deleted

Sample Code

obsClient.deleteObject({
       Bucket:'bucketname',
       Key:'objectkey'
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     console.log('VersionId-->' + result.InterfaceResult.VersionId);
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});

Parent topic: Object-Related APIs

Previous topic: PUT Object - Copy

Next topic: DELETE Objects