GET Bucket storageinfo
API Description
You can use this API to obtain storage information about a bucket, including the bucket size and number of objects in the bucket.
Method Definition
ObsClient.getBucketStorageInfo
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 |
|
Size |
String |
Bucket size |
|
ObjectNumber |
String |
Number of objects in the bucket |
|
StandardSize |
String |
Size of Standard objects in the bucket |
|
StandardObjectNumber |
String |
Number of Standard objects in the bucket |
|
WarmSize |
String |
Size of Infrequent Access objects in the bucket returned for an OBS request |
|
WarmObjectNumber |
String |
Number of Infrequent Access objects in the bucket returned for an OBS request |
|
ColdSize |
String |
Size of Archive objects in the bucket returned for an OBS request |
|
ColdObjectNumber |
String |
Number of Archive objects in the bucket returned for an OBS request |
|
DeepArchiveSize |
String |
Size of Deep Archive objects in the bucket |
|
DeepArchiveObjectNumber |
String |
Number of Deep Archive objects in the bucket |
Sample Code
obsClient.getBucketStorageInfo({
Bucket : 'bucketname'
},function (err, result) {
if(err){
console.error('Error-->' + err);
}else{
if(result.CommonMsg.Status < 300){
console.log('RequestId-->' + result.InterfaceResult.RequestId);
console.log('Size-->' + result.InterfaceResult.Size);
console.log('ObjectNumber-->' + result.InterfaceResult.ObjectNumber);
}else{
console.log('Code-->' + result.CommonMsg.Code);
console.log('Message-->' + result.CommonMsg.Message);
}
}
});
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