Bucket:Update Bucket Quota

Search (SHIFT+S)




New in this release

Update Bucket Quota

PUT /object/bucket/{bucketName}/quota

Updates the quota for the specified bucket. The payload specifies a limit at which a notification will be raised in the event log and a limit at which access will be blocked.

Both notification and block values must be supplied. If you do not want to define one of them, you can set its value to -1. You cannot set both values to -1 using this API. To set both notification and block values to -1, use the delete quota API.

bucketNameName of the bucket for which the quota is to be updated.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • NAMESPACE_ADMIN


Prerequisites

The following conditions must be met in order to call this operation.

  • Bucket must exist.


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<bucket_quota_param>
<blockSize> Block size in GB. Cannot be less than 1GB or use decimal values. Can be set to -1 to indicate quota value not defined. Long
<notificationSize> Notification size in GB. Cannot be less than 1GB or use decimal values. Can be set to -1 to indicate quota value not defined. Long
<namespace> Namespace to which this bucket belongs String
</bucket_quota_param>

Response Body

Response indicating Success or Failure of the operation


Examples

Request
PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/quota: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<bucket_quota_param>
   <blockSize>1</blockSize>
   <notificationSize>2</notificationSize>
   <namespace>s3</namespace>
</bucket_quota_param>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Notes: