Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Bucket Quota

GET /object/bucket/{bucketName}/quota

Gets the quota for the given bucket and namespace. The namespace with which the bucket is associated can be specified as a query parameter.

A value of -1 for the block or notification quota value indicates that no quota has been defined.

bucketNameName of the bucket which for which quota is to be retrieved

Query Parameters

namespaceNamespace with which bucket is associated. If it is null, the current user's namespace is used.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN


Prerequisites

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

  • Bucket must exist.


Response Body

Bucket quota details for the bucket.

Field Description Type Notes
bucket_quota_details
bucketname Bucket name String
namespace Namespace name String
blockSize Block size in GB. -1 indicates quota value not defined. Long
notificationSize Notification size in GB. -1 indicates quota value not defined. Long

Examples

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

Concept-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bucket_quota_details>
    <blockSize>-1</blockSize>
    <bucketname>standalone-bucket</bucketname>
    <namespace>s3</namespace>
    <notificationSize>-1</notificationSize>
</bucket_quota_details>