• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. API Reference (Node.js SDK)
  4. Objects-Related APIs
  5. DELETE Object

DELETE Object

API Description

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

Method Definition

ObsClient.deleteObject(parameter, callback)

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Key

String

Mandatory

Object name

VersionId

String

Optional

Object version ID

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

Object version ID

Sample Code

obsClient.deleteObject({
       Bucket:'bucketname',
       Key:'objectkey'
},(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);
              }
       }
});