PUT Bucket quota

Updated on 2023-03-16 GMT+08:00

View PDF

API Description

You can use this API to set the bucket quota. A bucket quota must be expressed in bytes and the maximum value is 2⁶³-1. Value 0 indicates that no upper limit is set for the bucket quota.

Method Definition

ObsClient.setBucketQuota

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.
StorageQuota	Number	Mandatory	Bucket quota. The value is a non-negative integer.

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

RequestDate

String

Date

Optional

Request time

NOTE:

When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.

StorageQuota

Number

Mandatory

Bucket quota. The value is a non-negative integer.

Returned Result (InterfaceResult)

Field	Type	Description
RequestId	String	Request ID returned by the OBS server

Sample Code

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