HEAD Bucket
API Description
You can use this API to check whether a bucket exists. If the returned HTTP status code is 200, the bucket exists. If the returned HTTP status code is 404, the bucket does not exist.
Method Definition
ObsClient.headBucket
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
---|---|---|---|
Bucket |
String |
Mandatory |
Bucket 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. |
Returned Result (InterfaceResult)
Field |
Type |
Description |
---|---|---|
RequestId |
String |
Request ID returned by the OBS server |
Sample Code
obsClient.headBucket({ Bucket : 'bucketname' }, function (err, result) { if(err){ console.error('Error-->' + err); }else{ if(result.CommonMsg.Status < 300){ console.log('Bucket exists'); }else if(result.CommonMsg.Status === 404){ console.log('Bucket does not exist'); } } });
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